file_dialog.cpp 86 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591
  1. /**************************************************************************/
  2. /* file_dialog.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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 "file_dialog.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "core/io/dir_access.h"
  34. #include "core/io/file_access.h"
  35. #include "core/os/keyboard.h"
  36. #include "scene/gui/box_container.h"
  37. #include "scene/gui/check_box.h"
  38. #include "scene/gui/flow_container.h"
  39. #include "scene/gui/grid_container.h"
  40. #include "scene/gui/item_list.h"
  41. #include "scene/gui/label.h"
  42. #include "scene/gui/line_edit.h"
  43. #include "scene/gui/menu_button.h"
  44. #include "scene/gui/option_button.h"
  45. #include "scene/gui/separator.h"
  46. #include "scene/gui/split_container.h"
  47. #include "scene/theme/theme_db.h"
  48. void FileDialog::popup_file_dialog() {
  49. popup_centered_clamped(Vector2(1050, 700) * get_theme_default_base_scale(), 0.8f);
  50. _focus_file_text();
  51. }
  52. void FileDialog::_focus_file_text() {
  53. int lp = filename_edit->get_text().rfind_char('.');
  54. if (lp != -1) {
  55. filename_edit->select(0, lp);
  56. if (filename_edit->is_inside_tree() && !is_part_of_edited_scene()) {
  57. filename_edit->grab_focus();
  58. }
  59. }
  60. }
  61. void FileDialog::_native_popup() {
  62. // Show native dialog directly.
  63. String root;
  64. if (!root_prefix.is_empty()) {
  65. root = ProjectSettings::get_singleton()->globalize_path(root_prefix);
  66. } else if (access == ACCESS_RESOURCES) {
  67. root = ProjectSettings::get_singleton()->get_resource_path();
  68. } else if (access == ACCESS_USERDATA) {
  69. root = OS::get_singleton()->get_user_data_dir();
  70. }
  71. // Attach native file dialog to first persistent parent window.
  72. Window *w = (is_transient() || is_transient_to_focused()) ? get_parent_visible_window() : nullptr;
  73. while (w && w->get_flag(FLAG_POPUP) && w->get_parent_visible_window()) {
  74. w = w->get_parent_visible_window();
  75. }
  76. DisplayServer::WindowID wid = w ? w->get_window_id() : DisplayServer::INVALID_WINDOW_ID;
  77. if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_EXTRA)) {
  78. DisplayServer::get_singleton()->file_dialog_with_options_show(get_displayed_title(), ProjectSettings::get_singleton()->globalize_path(full_dir), root, filename_edit->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), processed_filters, _get_options(), callable_mp(this, &FileDialog::_native_dialog_cb_with_options), wid);
  79. } else {
  80. DisplayServer::get_singleton()->file_dialog_show(get_displayed_title(), ProjectSettings::get_singleton()->globalize_path(full_dir), filename_edit->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), processed_filters, callable_mp(this, &FileDialog::_native_dialog_cb), wid);
  81. }
  82. }
  83. bool FileDialog::_can_use_native_popup() const {
  84. if (access == ACCESS_RESOURCES || access == ACCESS_USERDATA || options.size() > 0) {
  85. return DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_EXTRA);
  86. }
  87. return DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE);
  88. }
  89. void FileDialog::_popup_base(const Rect2i &p_screen_rect) {
  90. #ifdef TOOLS_ENABLED
  91. if (is_part_of_edited_scene()) {
  92. ConfirmationDialog::_popup_base(p_screen_rect);
  93. return;
  94. }
  95. #endif
  96. if (_should_use_native_popup()) {
  97. _native_popup();
  98. } else {
  99. ConfirmationDialog::_popup_base(p_screen_rect);
  100. }
  101. }
  102. void FileDialog::set_visible(bool p_visible) {
  103. if (p_visible) {
  104. _update_option_controls();
  105. }
  106. #ifdef TOOLS_ENABLED
  107. if (is_part_of_edited_scene()) {
  108. ConfirmationDialog::set_visible(p_visible);
  109. return;
  110. }
  111. #endif
  112. if (_should_use_native_popup()) {
  113. if (p_visible) {
  114. _native_popup();
  115. }
  116. } else {
  117. ConfirmationDialog::set_visible(p_visible);
  118. }
  119. }
  120. void FileDialog::_native_dialog_cb(bool p_ok, const Vector<String> &p_files, int p_filter) {
  121. _native_dialog_cb_with_options(p_ok, p_files, p_filter, Dictionary());
  122. }
  123. void FileDialog::_native_dialog_cb_with_options(bool p_ok, const Vector<String> &p_files, int p_filter, const Dictionary &p_selected_options) {
  124. if (!p_ok) {
  125. filename_edit->set_text("");
  126. emit_signal(SNAME("canceled"));
  127. return;
  128. }
  129. if (p_files.is_empty()) {
  130. return;
  131. }
  132. Vector<String> files = p_files;
  133. if (access != ACCESS_FILESYSTEM) {
  134. for (String &file_name : files) {
  135. file_name = ProjectSettings::get_singleton()->localize_path(file_name);
  136. }
  137. }
  138. selected_options = p_selected_options;
  139. String f = files[0];
  140. filter->select(p_filter);
  141. directory_edit->set_text(f.get_base_dir());
  142. filename_edit->set_text(f.get_file());
  143. _change_dir(f.get_base_dir());
  144. if (mode == FILE_MODE_OPEN_FILES) {
  145. emit_signal(SNAME("files_selected"), files);
  146. } else {
  147. if (mode == FILE_MODE_SAVE_FILE) {
  148. bool valid = false;
  149. if (p_filter == filter->get_item_count() - 1) {
  150. valid = true; // Match none.
  151. } else if (filters.size() > 1 && p_filter == 0) {
  152. // Match all filters.
  153. for (int i = 0; i < filters.size(); i++) {
  154. String flt = filters[i].get_slicec(';', 0);
  155. for (int j = 0; j < flt.get_slice_count(","); j++) {
  156. String str = flt.get_slicec(',', j).strip_edges();
  157. if (f.matchn(str)) {
  158. valid = true;
  159. break;
  160. }
  161. }
  162. if (valid) {
  163. break;
  164. }
  165. }
  166. } else {
  167. int idx = p_filter;
  168. if (filters.size() > 1) {
  169. idx--;
  170. }
  171. if (idx >= 0 && idx < filters.size()) {
  172. String flt = filters[idx].get_slicec(';', 0);
  173. int filter_slice_count = flt.get_slice_count(",");
  174. for (int j = 0; j < filter_slice_count; j++) {
  175. String str = flt.get_slicec(',', j).strip_edges();
  176. if (f.matchn(str)) {
  177. valid = true;
  178. break;
  179. }
  180. }
  181. if (!valid && filter_slice_count > 0) {
  182. String str = flt.get_slicec(',', 0).strip_edges();
  183. f += str.substr(1);
  184. filename_edit->set_text(f.get_file());
  185. valid = true;
  186. }
  187. } else {
  188. valid = true;
  189. }
  190. }
  191. // Add first extension of filter if no valid extension is found.
  192. if (!valid) {
  193. int idx = p_filter;
  194. String flt = filters[idx].get_slicec(';', 0);
  195. String ext = flt.get_slicec(',', 0).strip_edges().get_extension();
  196. f += "." + ext;
  197. }
  198. emit_signal(SNAME("file_selected"), f);
  199. } else if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
  200. emit_signal(SNAME("file_selected"), f);
  201. } else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
  202. emit_signal(SNAME("dir_selected"), f);
  203. }
  204. }
  205. }
  206. bool FileDialog::_should_use_native_popup() const {
  207. return _can_use_native_popup() && (use_native_dialog || OS::get_singleton()->is_sandboxed());
  208. }
  209. void FileDialog::_validate_property(PropertyInfo &p_property) const {
  210. if (p_property.name == "dialog_text") {
  211. // File dialogs have a custom layout, and dialog nodes can't have both a text and a layout.
  212. p_property.usage = PROPERTY_USAGE_NONE;
  213. }
  214. }
  215. void FileDialog::_notification(int p_what) {
  216. switch (p_what) {
  217. case NOTIFICATION_READY: {
  218. #ifdef TOOLS_ENABLED
  219. if (is_part_of_edited_scene()) {
  220. return;
  221. }
  222. #endif
  223. // Replace the built-in dialog with the native one if it started visible.
  224. if (is_visible() && _should_use_native_popup()) {
  225. ConfirmationDialog::set_visible(false);
  226. _native_popup();
  227. }
  228. } break;
  229. case NOTIFICATION_VISIBILITY_CHANGED: {
  230. if (is_visible()) {
  231. _update_favorite_list();
  232. _update_recent_list();
  233. invalidate(); // Put it here to preview in the editor.
  234. }
  235. } break;
  236. case NOTIFICATION_TRANSLATION_CHANGED: {
  237. update_filters();
  238. [[fallthrough]];
  239. }
  240. case Control::NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
  241. if (main_vbox->is_layout_rtl()) {
  242. _setup_button(dir_prev, theme_cache.forward_folder);
  243. _setup_button(dir_next, theme_cache.back_folder);
  244. } else {
  245. _setup_button(dir_prev, theme_cache.back_folder);
  246. _setup_button(dir_next, theme_cache.forward_folder);
  247. }
  248. } break;
  249. case NOTIFICATION_THEME_CHANGED: {
  250. favorite_list->set_custom_minimum_size(Vector2(128 * get_theme_default_base_scale(), 0));
  251. recent_list->set_custom_minimum_size(Vector2(128 * get_theme_default_base_scale(), 0));
  252. if (main_vbox->is_layout_rtl()) {
  253. _setup_button(dir_prev, theme_cache.forward_folder);
  254. _setup_button(dir_next, theme_cache.back_folder);
  255. } else {
  256. _setup_button(dir_prev, theme_cache.back_folder);
  257. _setup_button(dir_next, theme_cache.forward_folder);
  258. }
  259. _setup_button(dir_up, theme_cache.parent_folder);
  260. _setup_button(refresh_button, theme_cache.reload);
  261. _setup_button(favorite_button, theme_cache.favorite);
  262. _setup_button(make_dir_button, theme_cache.create_folder);
  263. _setup_button(show_hidden, theme_cache.toggle_hidden);
  264. _setup_button(thumbnail_mode_button, theme_cache.thumbnail_mode);
  265. _setup_button(list_mode_button, theme_cache.list_mode);
  266. _setup_button(show_filename_filter_button, theme_cache.toggle_filename_filter);
  267. _setup_button(file_sort_button, theme_cache.sort);
  268. _setup_button(fav_up_button, theme_cache.favorite_up);
  269. _setup_button(fav_down_button, theme_cache.favorite_down);
  270. invalidate();
  271. } break;
  272. case NOTIFICATION_WM_WINDOW_FOCUS_IN: {
  273. if (!is_visible()) {
  274. return;
  275. }
  276. // Check if the current directory was removed externally (much less likely to happen while the window is focused).
  277. const String previous_dir = get_current_dir();
  278. while (!dir_access->dir_exists(get_current_dir())) {
  279. _go_up();
  280. // In case we can't go further up, use some fallback and break.
  281. if (get_current_dir() == previous_dir) {
  282. _dir_submitted(OS::get_singleton()->get_user_data_dir());
  283. break;
  284. }
  285. }
  286. } break;
  287. }
  288. }
  289. void FileDialog::shortcut_input(const Ref<InputEvent> &p_event) {
  290. if (p_event.is_null() || p_event->is_released() || p_event->is_echo()) {
  291. return;
  292. }
  293. for (const KeyValue<ItemMenu, Ref<Shortcut>> &action : action_shortcuts) {
  294. if (action.value->matches_event(p_event)) {
  295. _item_menu_id_pressed(action.key);
  296. set_input_as_handled();
  297. break;
  298. }
  299. }
  300. }
  301. Vector<String> FileDialog::get_selected_files() const {
  302. const String current_dir = dir_access->get_current_dir();
  303. Vector<String> list;
  304. for (int idx : file_list->get_selected_items()) {
  305. list.push_back(current_dir.path_join(file_list->get_item_text(idx)));
  306. }
  307. return list;
  308. }
  309. void FileDialog::update_dir() {
  310. full_dir = dir_access->get_current_dir();
  311. if (root_prefix.is_empty()) {
  312. directory_edit->set_text(dir_access->get_current_dir(false));
  313. } else {
  314. directory_edit->set_text(dir_access->get_current_dir(false).trim_prefix(root_prefix).trim_prefix("/"));
  315. }
  316. if (drives->is_visible()) {
  317. if (dir_access->get_current_dir().is_network_share_path()) {
  318. _update_drives(false);
  319. drives->add_item(ETR("Network"));
  320. drives->set_item_disabled(-1, true);
  321. drives->select(drives->get_item_count() - 1);
  322. } else {
  323. drives->select(dir_access->get_current_drive());
  324. }
  325. }
  326. // Deselect any item, to make "Select Current Folder" button text by default.
  327. deselect_all();
  328. }
  329. void FileDialog::_dir_submitted(String p_dir) {
  330. String new_dir = p_dir;
  331. #ifdef WINDOWS_ENABLED
  332. if (root_prefix.is_empty() && drives->is_visible() && !new_dir.is_network_share_path() && new_dir.is_absolute_path() && new_dir.find(":/") == -1 && new_dir.find(":\\") == -1) {
  333. // Non network path without X:/ prefix on Windows, add drive letter.
  334. new_dir = drives->get_item_text(drives->get_selected()).path_join(new_dir);
  335. }
  336. #endif
  337. if (!root_prefix.is_empty()) {
  338. new_dir = root_prefix.path_join(new_dir);
  339. }
  340. _change_dir(new_dir);
  341. filename_edit->set_text("");
  342. _push_history();
  343. }
  344. void FileDialog::_save_confirm_pressed() {
  345. _save_to_recent();
  346. String f = dir_access->get_current_dir().path_join(filename_edit->get_text());
  347. hide();
  348. emit_signal(SNAME("file_selected"), f);
  349. }
  350. void FileDialog::_post_popup() {
  351. ConfirmationDialog::_post_popup();
  352. if (mode == FILE_MODE_SAVE_FILE) {
  353. filename_edit->grab_focus(true);
  354. } else {
  355. file_list->grab_focus(true);
  356. }
  357. // For open dir mode, deselect all items on file dialog open.
  358. if (mode == FILE_MODE_OPEN_DIR) {
  359. deselect_all();
  360. file_box->set_visible(false);
  361. } else {
  362. file_box->set_visible(true);
  363. }
  364. local_history.clear();
  365. local_history_pos = -1;
  366. _push_history();
  367. }
  368. void FileDialog::_push_history() {
  369. local_history.resize(local_history_pos + 1);
  370. String new_path = dir_access->get_current_dir();
  371. if (local_history.is_empty() || new_path != local_history[local_history_pos]) {
  372. local_history.push_back(new_path);
  373. local_history_pos++;
  374. dir_prev->set_disabled(local_history_pos == 0);
  375. dir_next->set_disabled(true);
  376. }
  377. }
  378. void FileDialog::_action_pressed() {
  379. if (mode == FILE_MODE_OPEN_FILES) {
  380. const Vector<String> files = get_selected_files();
  381. if (!files.is_empty()) {
  382. _save_to_recent();
  383. hide();
  384. emit_signal(SNAME("files_selected"), files);
  385. }
  386. return;
  387. }
  388. String file_text = filename_edit->get_text();
  389. String f = file_text.is_absolute_path() ? file_text : dir_access->get_current_dir().path_join(file_text);
  390. if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && (dir_access->file_exists(f) || dir_access->is_bundle(f))) {
  391. _save_to_recent();
  392. hide();
  393. emit_signal(SNAME("file_selected"), f);
  394. } else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
  395. String path = dir_access->get_current_dir();
  396. path = path.replace_char('\\', '/');
  397. int selected = _get_selected_file_idx();
  398. if (selected > -1) {
  399. Dictionary d = file_list->get_item_metadata(selected);
  400. if (d["dir"] && d["name"] != "..") {
  401. path = path.path_join(d["name"]);
  402. }
  403. }
  404. _save_to_recent();
  405. hide();
  406. emit_signal(SNAME("dir_selected"), path);
  407. }
  408. if (mode == FILE_MODE_SAVE_FILE) {
  409. bool valid = false;
  410. if (filter->get_selected() == filter->get_item_count() - 1) {
  411. valid = true; // Match none.
  412. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  413. // Match all filters.
  414. for (int i = 0; i < filters.size(); i++) {
  415. String flt = filters[i].get_slicec(';', 0);
  416. for (int j = 0; j < flt.get_slice_count(","); j++) {
  417. String str = flt.get_slicec(',', j).strip_edges();
  418. if (f.matchn(str)) {
  419. valid = true;
  420. break;
  421. }
  422. }
  423. if (valid) {
  424. break;
  425. }
  426. }
  427. } else {
  428. int idx = filter->get_selected();
  429. if (filters.size() > 1) {
  430. idx--;
  431. }
  432. if (idx >= 0 && idx < filters.size()) {
  433. String flt = filters[idx].get_slicec(';', 0);
  434. int filter_slice_count = flt.get_slice_count(",");
  435. for (int j = 0; j < filter_slice_count; j++) {
  436. String str = (flt.get_slicec(',', j).strip_edges());
  437. if (f.matchn(str)) {
  438. valid = true;
  439. break;
  440. }
  441. }
  442. if (!valid && filter_slice_count > 0) {
  443. String str = flt.get_slicec(',', 0).strip_edges();
  444. f += str.substr(1);
  445. filename_edit->set_text(f.get_file());
  446. valid = true;
  447. }
  448. } else {
  449. valid = true;
  450. }
  451. }
  452. String file_name = file_text.strip_edges().get_file();
  453. if (!valid || file_name.is_empty()) {
  454. exterr->popup_centered(Size2(250, 80));
  455. return;
  456. }
  457. if (customization_flags[CUSTOMIZATION_OVERWRITE_WARNING] && (dir_access->file_exists(f) || dir_access->is_bundle(f))) {
  458. confirm_save->set_text(vformat(atr(ETR("File \"%s\" already exists.\nDo you want to overwrite it?")), f));
  459. confirm_save->popup_centered(Size2(250, 80));
  460. } else {
  461. _save_to_recent();
  462. hide();
  463. emit_signal(SNAME("file_selected"), f);
  464. }
  465. }
  466. }
  467. void FileDialog::_cancel_pressed() {
  468. filename_edit->set_text("");
  469. hide();
  470. }
  471. bool FileDialog::_is_open_should_be_disabled() {
  472. if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_SAVE_FILE) {
  473. return false;
  474. }
  475. Vector<int> items = file_list->get_selected_items();
  476. if (items.is_empty()) {
  477. return mode != FILE_MODE_OPEN_DIR; // In "Open folder" mode, having nothing selected picks the current folder.
  478. }
  479. for (const int idx : items) {
  480. Dictionary d = file_list->get_item_metadata(idx);
  481. if (((mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES) && d["dir"]) || (mode == FILE_MODE_OPEN_DIR && !d["dir"])) {
  482. return true;
  483. }
  484. }
  485. return false;
  486. }
  487. void FileDialog::_go_up() {
  488. _change_dir(get_current_dir().trim_suffix("/").get_base_dir());
  489. _push_history();
  490. }
  491. void FileDialog::_go_back() {
  492. if (local_history_pos <= 0) {
  493. return;
  494. }
  495. local_history_pos--;
  496. _change_dir(local_history[local_history_pos]);
  497. dir_prev->set_disabled(local_history_pos == 0);
  498. dir_next->set_disabled(local_history_pos == local_history.size() - 1);
  499. }
  500. void FileDialog::_go_forward() {
  501. if (local_history_pos >= local_history.size() - 1) {
  502. return;
  503. }
  504. local_history_pos++;
  505. _change_dir(local_history[local_history_pos]);
  506. dir_prev->set_disabled(local_history_pos == 0);
  507. dir_next->set_disabled(local_history_pos == local_history.size() - 1);
  508. }
  509. void FileDialog::deselect_all() {
  510. // Clear currently selected items in file manager.
  511. file_list->deselect_all();
  512. // And change get_ok title.
  513. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  514. switch (mode) {
  515. case FILE_MODE_OPEN_FILE:
  516. case FILE_MODE_OPEN_FILES:
  517. set_default_ok_text(ETR("Open"));
  518. break;
  519. case FILE_MODE_OPEN_DIR:
  520. set_default_ok_text(ETR("Select Current Folder"));
  521. break;
  522. case FILE_MODE_OPEN_ANY:
  523. set_default_ok_text(ETR("Open"));
  524. break;
  525. case FILE_MODE_SAVE_FILE:
  526. set_default_ok_text(ETR("Save"));
  527. break;
  528. }
  529. }
  530. int FileDialog::_get_selected_file_idx() {
  531. const PackedInt32Array selected = file_list->get_selected_items();
  532. return selected.is_empty() ? -1 : selected[0];
  533. }
  534. String FileDialog::_get_item_path(int p_idx) const {
  535. const Dictionary meta = file_list->get_item_metadata(p_idx);
  536. return ProjectSettings::get_singleton()->globalize_path(dir_access->get_current_dir().path_join(meta["name"]));
  537. }
  538. void FileDialog::_file_list_multi_selected(int p_item, bool p_selected) {
  539. if (p_selected) {
  540. _file_list_selected(p_item);
  541. } else {
  542. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  543. }
  544. }
  545. void FileDialog::_file_list_selected(int p_item) {
  546. Dictionary d = file_list->get_item_metadata(p_item);
  547. if (!d["dir"]) {
  548. filename_edit->set_text(d["name"]);
  549. if (mode == FILE_MODE_SAVE_FILE) {
  550. set_default_ok_text(ETR("Save"));
  551. } else {
  552. set_default_ok_text(ETR("Open"));
  553. }
  554. } else if (mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY || !dir_access->file_exists(filename_edit->get_text())) {
  555. filename_edit->set_text("");
  556. if (mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
  557. set_default_ok_text(ETR("Select This Folder"));
  558. }
  559. }
  560. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  561. }
  562. void FileDialog::_file_list_item_activated(int p_item) {
  563. Dictionary d = file_list->get_item_metadata(p_item);
  564. if (d["dir"]) {
  565. _change_dir(d["name"]);
  566. if (mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES || mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
  567. filename_edit->set_text("");
  568. }
  569. _push_history();
  570. } else {
  571. _action_pressed();
  572. }
  573. }
  574. void FileDialog::update_file_name() {
  575. int idx = filter->get_selected() - 1;
  576. if ((idx == -1 && filter->get_item_count() == 2) || (filter->get_item_count() > 2 && idx >= 0 && idx < filter->get_item_count() - 2)) {
  577. if (idx == -1) {
  578. idx += 1;
  579. }
  580. String filter_str = filters[idx];
  581. String file_str = filename_edit->get_text();
  582. String base_name = file_str.get_basename();
  583. Vector<String> filter_substr = filter_str.split(";");
  584. if (filter_substr.size() >= 2) {
  585. file_str = base_name + "." + filter_substr[0].strip_edges().get_extension().to_lower();
  586. } else {
  587. file_str = base_name + "." + filter_str.strip_edges().get_extension().to_lower();
  588. }
  589. filename_edit->set_text(file_str);
  590. }
  591. }
  592. void FileDialog::_item_menu_id_pressed(int p_option) {
  593. int selected = _get_selected_file_idx();
  594. switch (p_option) {
  595. case ITEM_MENU_COPY_PATH: {
  596. if (selected > -1) {
  597. DisplayServer::get_singleton()->clipboard_set(_get_item_path(selected));
  598. }
  599. } break;
  600. case ITEM_MENU_DELETE: {
  601. if (selected > -1) {
  602. delete_dialog->popup_centered(Size2(250, 80));
  603. }
  604. } break;
  605. case ITEM_MENU_REFRESH: {
  606. invalidate();
  607. } break;
  608. case ITEM_MENU_NEW_FOLDER: {
  609. _make_dir();
  610. } break;
  611. case ITEM_MENU_SHOW_IN_EXPLORER: {
  612. String path;
  613. if (selected > -1) {
  614. path = _get_item_path(selected);
  615. } else {
  616. path = ProjectSettings::get_singleton()->globalize_path(dir_access->get_current_dir());
  617. }
  618. OS::get_singleton()->shell_show_in_file_manager(path, true);
  619. } break;
  620. case ITEM_MENU_SHOW_BUNDLE_CONTENT: {
  621. if (selected == -1) {
  622. return;
  623. }
  624. Dictionary meta = file_list->get_item_metadata(selected);
  625. _change_dir(meta["name"]);
  626. if (mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES || mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
  627. filename_edit->set_text("");
  628. }
  629. _push_history();
  630. } break;
  631. case ITEM_MENU_GO_UP: {
  632. _dir_submitted("..");
  633. } break;
  634. case ITEM_MENU_TOGGLE_HIDDEN: {
  635. set_show_hidden_files(!show_hidden_files);
  636. } break;
  637. case ITEM_MENU_FIND: {
  638. show_filename_filter_button->set_pressed(!show_filename_filter_button->is_pressed());
  639. } break;
  640. case ITEM_MENU_FOCUS_PATH: {
  641. directory_edit->grab_focus();
  642. directory_edit->select_all();
  643. } break;
  644. }
  645. }
  646. void FileDialog::_empty_clicked(const Vector2 &p_pos, MouseButton p_button) {
  647. if (p_button == MouseButton::RIGHT) {
  648. _popup_menu(p_pos, -1);
  649. } else if (p_button == MouseButton::LEFT) {
  650. deselect_all();
  651. }
  652. }
  653. void FileDialog::_item_clicked(int p_item, const Vector2 &p_pos, MouseButton p_button) {
  654. if (p_button == MouseButton::RIGHT) {
  655. _popup_menu(p_pos, p_item);
  656. }
  657. }
  658. void FileDialog::_popup_menu(const Vector2 &p_pos, int p_for_item) {
  659. item_menu->clear();
  660. if (p_for_item > -1) {
  661. item_menu->add_item(ETR("Copy Path"), ITEM_MENU_COPY_PATH);
  662. if (customization_flags[CUSTOMIZATION_DELETE]) {
  663. item_menu->add_item(ETR("Delete"), ITEM_MENU_DELETE);
  664. item_menu->set_item_shortcut(-1, action_shortcuts[ITEM_MENU_DELETE]);
  665. }
  666. } else {
  667. if (can_create_folders) {
  668. item_menu->add_item(ETR("New Folder..."), ITEM_MENU_NEW_FOLDER);
  669. }
  670. item_menu->add_item(ETR("Refresh"), ITEM_MENU_REFRESH);
  671. item_menu->set_item_shortcut(-1, action_shortcuts[ITEM_MENU_REFRESH]);
  672. }
  673. #if !defined(ANDROID_ENABLED) && !defined(WEB_ENABLED)
  674. // Opening the system file manager is not supported on the Android and web editors.
  675. item_menu->add_separator();
  676. Dictionary meta;
  677. if (p_for_item > -1) {
  678. meta = file_list->get_item_metadata(p_for_item);
  679. }
  680. item_menu->add_item((p_for_item == -1 || meta["dir"]) ? ETR("Open in File Manager") : ETR("Show in File Manager"), ITEM_MENU_SHOW_IN_EXPLORER);
  681. if (meta["bundle"]) {
  682. item_menu->add_item(ETR("Show Package Contents"), ITEM_MENU_SHOW_BUNDLE_CONTENT);
  683. }
  684. #endif
  685. if (item_menu->get_item_count() == 0) {
  686. return;
  687. }
  688. item_menu->set_position(file_list->get_screen_position() + p_pos);
  689. item_menu->reset_size();
  690. item_menu->popup();
  691. }
  692. void FileDialog::update_file_list() {
  693. file_list->clear();
  694. // Scroll back to the top after opening a directory
  695. file_list->get_v_scroll_bar()->set_value(0);
  696. if (display_mode == DISPLAY_THUMBNAILS) {
  697. file_list->set_max_columns(0);
  698. file_list->set_icon_mode(ItemList::ICON_MODE_TOP);
  699. file_list->set_fixed_column_width(theme_cache.thumbnail_size * 3 / 2);
  700. file_list->set_max_text_lines(2);
  701. file_list->set_text_overrun_behavior(TextServer::OVERRUN_TRIM_ELLIPSIS);
  702. file_list->set_fixed_icon_size(Size2(theme_cache.thumbnail_size, theme_cache.thumbnail_size));
  703. } else {
  704. file_list->set_icon_mode(ItemList::ICON_MODE_LEFT);
  705. file_list->set_max_columns(1);
  706. file_list->set_max_text_lines(1);
  707. file_list->set_fixed_column_width(0);
  708. file_list->set_fixed_icon_size(theme_cache.file->get_size());
  709. }
  710. dir_access->list_dir_begin();
  711. if (dir_access->is_readable(dir_access->get_current_dir().utf8().get_data())) {
  712. message->hide();
  713. } else {
  714. message->set_text(ETR("You don't have permission to access contents of this folder."));
  715. message->show();
  716. }
  717. LocalVector<String> files;
  718. LocalVector<String> dirs;
  719. String item = dir_access->get_next();
  720. while (!item.is_empty()) {
  721. if (item == "." || item == "..") {
  722. item = dir_access->get_next();
  723. continue;
  724. }
  725. if (show_hidden_files || (!dir_access->current_is_hidden() && !_should_hide_file(item))) {
  726. if (!dir_access->current_is_dir()) {
  727. files.push_back(item);
  728. } else {
  729. dirs.push_back(item);
  730. }
  731. }
  732. item = dir_access->get_next();
  733. }
  734. String filename_filter_lower = file_name_filter.to_lower();
  735. List<String> patterns;
  736. // Build filter.
  737. if (filter->get_selected() == filter->get_item_count() - 1) {
  738. // Match all.
  739. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  740. // Match all filters.
  741. for (int i = 0; i < filters.size(); i++) {
  742. String f = filters[i].get_slicec(';', 0);
  743. for (int j = 0; j < f.get_slice_count(","); j++) {
  744. patterns.push_back(f.get_slicec(',', j).strip_edges());
  745. }
  746. }
  747. } else {
  748. int idx = filter->get_selected();
  749. if (filters.size() > 1) {
  750. idx--;
  751. }
  752. if (idx >= 0 && idx < filters.size()) {
  753. String f = filters[idx].get_slicec(';', 0);
  754. for (int j = 0; j < f.get_slice_count(","); j++) {
  755. patterns.push_back(f.get_slicec(',', j).strip_edges());
  756. }
  757. }
  758. }
  759. LocalVector<DirInfo> filtered_dirs;
  760. filtered_dirs.reserve(dirs.size());
  761. const String base_dir = dir_access->get_current_dir();
  762. for (const String &dir_name : dirs) {
  763. bool bundle = dir_access->is_bundle(dir_name);
  764. bool found = true;
  765. if (bundle) {
  766. bool match = patterns.is_empty();
  767. for (const String &E : patterns) {
  768. if (dir_name.matchn(E)) {
  769. match = true;
  770. break;
  771. }
  772. }
  773. found = match;
  774. }
  775. if (found && (filename_filter_lower.is_empty() || dir_name.to_lower().contains(filename_filter_lower))) {
  776. DirInfo di;
  777. di.name = dir_name;
  778. di.bundle = bundle;
  779. if (file_sort == FileSortOption::MODIFIED_TIME || file_sort == FileSortOption::MODIFIED_TIME_REVERSE) {
  780. di.modified_time = FileAccess::get_modified_time(base_dir.path_join(dir_name));
  781. }
  782. filtered_dirs.push_back(di);
  783. }
  784. }
  785. if (file_sort == FileSortOption::MODIFIED_TIME || file_sort == FileSortOption::MODIFIED_TIME_REVERSE) {
  786. filtered_dirs.sort_custom<DirInfo::TimeComparator>();
  787. } else {
  788. filtered_dirs.sort_custom<DirInfo::NameComparator>();
  789. }
  790. if (file_sort == FileSortOption::NAME_REVERSE || file_sort == FileSortOption::MODIFIED_TIME_REVERSE) {
  791. filtered_dirs.reverse();
  792. }
  793. for (const DirInfo &info : filtered_dirs) {
  794. if (display_mode == DISPLAY_THUMBNAILS) {
  795. file_list->add_item(info.name, info.bundle ? theme_cache.file_thumbnail : theme_cache.folder_thumbnail);
  796. } else {
  797. file_list->add_item(info.name, info.bundle ? theme_cache.file : theme_cache.folder);
  798. }
  799. file_list->set_item_icon_modulate(-1, _get_folder_color(base_dir.path_join(info.name)));
  800. Dictionary d;
  801. d["name"] = info.name;
  802. d["dir"] = !info.bundle;
  803. d["bundle"] = info.bundle;
  804. file_list->set_item_metadata(-1, d);
  805. }
  806. LocalVector<FileInfo> filtered_files;
  807. filtered_files.reserve(files.size());
  808. for (const String &filename : files) {
  809. bool match = patterns.is_empty();
  810. String match_str;
  811. for (const String &E : patterns) {
  812. if (filename.matchn(E)) {
  813. match_str = E;
  814. match = true;
  815. break;
  816. }
  817. }
  818. if (match && (filename_filter_lower.is_empty() || filename.to_lower().contains(filename_filter_lower))) {
  819. FileInfo fi;
  820. fi.name = filename;
  821. fi.match_string = match_str;
  822. // Only assign sorting fields when needed.
  823. if (file_sort == FileSortOption::TYPE || file_sort == FileSortOption::TYPE_REVERSE) {
  824. fi.type_sort = filename.get_extension() + filename.get_basename();
  825. } else if (file_sort == FileSortOption::MODIFIED_TIME || file_sort == FileSortOption::MODIFIED_TIME_REVERSE) {
  826. fi.modified_time = FileAccess::get_modified_time(base_dir.path_join(filename));
  827. }
  828. filtered_files.push_back(fi);
  829. }
  830. }
  831. switch (file_sort) {
  832. case FileSortOption::NAME:
  833. case FileSortOption::NAME_REVERSE:
  834. filtered_files.sort_custom<FileInfo::NameComparator>();
  835. break;
  836. case FileSortOption::TYPE:
  837. case FileSortOption::TYPE_REVERSE:
  838. filtered_files.sort_custom<FileInfo::TypeComparator>();
  839. break;
  840. case FileSortOption::MODIFIED_TIME:
  841. case FileSortOption::MODIFIED_TIME_REVERSE:
  842. filtered_files.sort_custom<FileInfo::TimeComparator>();
  843. break;
  844. default:
  845. ERR_PRINT(vformat("Invalid FileDialog sort option: %d", int(file_sort)));
  846. }
  847. if (file_sort == FileSortOption::NAME_REVERSE || file_sort == FileSortOption::TYPE_REVERSE || file_sort == FileSortOption::MODIFIED_TIME_REVERSE) {
  848. filtered_files.reverse();
  849. }
  850. for (const FileInfo &info : filtered_files) {
  851. file_list->add_item(info.name);
  852. const String path = base_dir.path_join(info.name);
  853. Ref<Texture2D> icon;
  854. if (get_icon_callback.is_valid()) {
  855. const Variant &v = path;
  856. const Variant *argptrs[1] = { &v };
  857. Variant vicon;
  858. Callable::CallError ce;
  859. get_icon_callback.callp(argptrs, 1, vicon, ce);
  860. if (unlikely(ce.error != Callable::CallError::CALL_OK)) {
  861. ERR_PRINT(vformat("Error calling FileDialog's icon callback: %s.", Variant::get_callable_error_text(get_icon_callback, argptrs, 1, ce)));
  862. }
  863. icon = vicon;
  864. }
  865. if (display_mode == DISPLAY_LIST) {
  866. if (icon.is_null()) {
  867. icon = theme_cache.file;
  868. }
  869. file_list->set_item_icon(-1, icon);
  870. } else { // DISPLAY_THUMBNAILS
  871. Ref<Texture2D> thumbnail;
  872. if (get_thumbnail_callback.is_valid()) {
  873. const Variant &v = path;
  874. const Variant *argptrs[1] = { &v };
  875. Variant vicon;
  876. Callable::CallError ce;
  877. get_thumbnail_callback.callp(argptrs, 1, vicon, ce);
  878. if (unlikely(ce.error != Callable::CallError::CALL_OK)) {
  879. ERR_PRINT(vformat("Error calling FileDialog's thumbnail callback: %s.", Variant::get_callable_error_text(get_thumbnail_callback, argptrs, 1, ce)));
  880. }
  881. thumbnail = vicon;
  882. }
  883. if (thumbnail.is_null()) {
  884. thumbnail = theme_cache.file_thumbnail;
  885. }
  886. file_list->set_item_icon(-1, thumbnail);
  887. if (icon.is_valid()) {
  888. file_list->set_item_tag_icon(-1, icon);
  889. }
  890. }
  891. file_list->set_item_icon_modulate(-1, theme_cache.file_icon_color);
  892. if (mode == FILE_MODE_OPEN_DIR) {
  893. file_list->set_item_disabled(-1, true);
  894. }
  895. Dictionary d;
  896. d["name"] = info.name;
  897. d["dir"] = false;
  898. d["bundle"] = false;
  899. file_list->set_item_metadata(-1, d);
  900. if (filename_edit->get_text() == info.name || info.match_string == info.name) {
  901. file_list->select(file_list->get_item_count() - 1);
  902. }
  903. }
  904. if (mode != FILE_MODE_SAVE_FILE && mode != FILE_MODE_OPEN_DIR) {
  905. // Select the first file from list if nothing is selected.
  906. int selected = _get_selected_file_idx();
  907. if (selected == -1) {
  908. _file_list_select_first();
  909. }
  910. }
  911. favorite_list->deselect_all();
  912. favorite_button->set_pressed(false);
  913. const int fav_count = favorite_list->get_item_count();
  914. for (int i = 0; i < fav_count; i++) {
  915. const String fav_dir = favorite_list->get_item_metadata(i);
  916. if (fav_dir != base_dir && fav_dir != base_dir + "/") {
  917. continue;
  918. }
  919. favorite_list->select(i);
  920. favorite_button->set_pressed(true);
  921. break;
  922. }
  923. _update_fav_buttons();
  924. }
  925. void FileDialog::_filter_selected(int) {
  926. update_file_name();
  927. update_file_list();
  928. }
  929. void FileDialog::_filename_filter_changed() {
  930. update_filename_filter();
  931. update_file_list();
  932. callable_mp(this, &FileDialog::_file_list_select_first).call_deferred();
  933. }
  934. void FileDialog::_file_list_select_first() {
  935. if (file_list->get_item_count() > 0) {
  936. file_list->select(0);
  937. _file_list_selected(0);
  938. }
  939. }
  940. void FileDialog::_delete_confirm() {
  941. Error err = OS::get_singleton()->move_to_trash(_get_item_path(_get_selected_file_idx()));
  942. if (err == OK) {
  943. invalidate();
  944. _dir_contents_changed();
  945. }
  946. }
  947. void FileDialog::_filename_filter_selected() {
  948. int selected = _get_selected_file_idx();
  949. if (selected > -1) {
  950. filename_edit->set_text(file_list->get_item_text(selected));
  951. filename_edit->emit_signal(SceneStringName(text_submitted), filename_edit->get_text());
  952. }
  953. }
  954. void FileDialog::update_filters() {
  955. filter->clear();
  956. processed_filters.clear();
  957. if (filters.size() > 1) {
  958. String all_filters;
  959. String all_mime;
  960. String all_filters_full;
  961. String all_mime_full;
  962. const int max_filters = 5;
  963. // "All Recognized" display name.
  964. for (int i = 0; i < MIN(max_filters, filters.size()); i++) {
  965. String flt = filters[i].get_slicec(';', 0).strip_edges();
  966. if (!all_filters.is_empty() && !flt.is_empty()) {
  967. all_filters += ", ";
  968. }
  969. all_filters += flt;
  970. String mime = filters[i].get_slicec(';', 2).strip_edges();
  971. if (!all_mime.is_empty() && !mime.is_empty()) {
  972. all_mime += ", ";
  973. }
  974. all_mime += mime;
  975. }
  976. // "All Recognized" filter.
  977. for (int i = 0; i < filters.size(); i++) {
  978. String flt = filters[i].get_slicec(';', 0).strip_edges();
  979. if (!all_filters_full.is_empty() && !flt.is_empty()) {
  980. all_filters_full += ",";
  981. }
  982. all_filters_full += flt;
  983. String mime = filters[i].get_slicec(';', 2).strip_edges();
  984. if (!all_mime_full.is_empty() && !mime.is_empty()) {
  985. all_mime_full += ",";
  986. }
  987. all_mime_full += mime;
  988. }
  989. String native_all_name;
  990. native_all_name += all_filters;
  991. if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_MIME)) {
  992. if (!native_all_name.is_empty()) {
  993. native_all_name += ", ";
  994. }
  995. native_all_name += all_mime;
  996. }
  997. if (max_filters < filters.size()) {
  998. all_filters += ", ...";
  999. native_all_name += ", ...";
  1000. }
  1001. filter->add_item(atr(ETR("All Recognized")) + " (" + all_filters + ")");
  1002. processed_filters.push_back(all_filters_full + ";" + atr(ETR("All Recognized")) + " (" + native_all_name + ")" + ";" + all_mime_full);
  1003. }
  1004. for (int i = 0; i < filters.size(); i++) {
  1005. String flt = filters[i].get_slicec(';', 0).strip_edges();
  1006. String desc = filters[i].get_slicec(';', 1).strip_edges();
  1007. String mime = filters[i].get_slicec(';', 2).strip_edges();
  1008. String native_name;
  1009. native_name += flt;
  1010. if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_MIME)) {
  1011. if (!native_name.is_empty() && !mime.is_empty()) {
  1012. native_name += ", ";
  1013. }
  1014. native_name += mime;
  1015. }
  1016. if (!desc.is_empty()) {
  1017. filter->add_item(atr(desc) + " (" + flt + ")");
  1018. processed_filters.push_back(flt + ";" + atr(desc) + " (" + native_name + ");" + mime);
  1019. } else {
  1020. filter->add_item("(" + flt + ")");
  1021. processed_filters.push_back(flt + ";(" + native_name + ");" + mime);
  1022. }
  1023. }
  1024. String f = atr(ETR("All Files")) + " (*.*)";
  1025. filter->add_item(f);
  1026. processed_filters.push_back("*.*;" + f + ";application/octet-stream");
  1027. }
  1028. void FileDialog::update_customization() {
  1029. _update_make_dir_visible();
  1030. show_hidden->set_visible(customization_flags[CUSTOMIZATION_HIDDEN_FILES]);
  1031. layout_container->set_visible(customization_flags[CUSTOMIZATION_LAYOUT]);
  1032. layout_separator->set_visible(customization_flags[CUSTOMIZATION_FILE_FILTER] || customization_flags[CUSTOMIZATION_FILE_SORT]);
  1033. show_filename_filter_button->set_visible(customization_flags[CUSTOMIZATION_FILE_FILTER]);
  1034. file_sort_button->set_visible(customization_flags[CUSTOMIZATION_FILE_SORT]);
  1035. show_hidden_separator->set_visible(customization_flags[CUSTOMIZATION_HIDDEN_FILES] && (customization_flags[CUSTOMIZATION_LAYOUT] || customization_flags[CUSTOMIZATION_FILE_FILTER] || customization_flags[CUSTOMIZATION_FILE_SORT]));
  1036. favorite_button->set_visible(customization_flags[CUSTOMIZATION_FAVORITES]);
  1037. favorite_vbox->set_visible(customization_flags[CUSTOMIZATION_FAVORITES]);
  1038. recent_vbox->set_visible(customization_flags[CUSTOMIZATION_RECENT]);
  1039. }
  1040. void FileDialog::clear_filename_filter() {
  1041. set_filename_filter("");
  1042. update_filename_filter_gui();
  1043. invalidate();
  1044. }
  1045. void FileDialog::update_filename_filter_gui() {
  1046. filename_filter_box->set_visible(show_filename_filter);
  1047. if (!show_filename_filter) {
  1048. file_name_filter.clear();
  1049. }
  1050. if (filename_filter->get_text() == file_name_filter) {
  1051. return;
  1052. }
  1053. filename_filter->set_text(file_name_filter);
  1054. }
  1055. void FileDialog::update_filename_filter() {
  1056. if (filename_filter->get_text() == file_name_filter) {
  1057. return;
  1058. }
  1059. set_filename_filter(filename_filter->get_text());
  1060. }
  1061. void FileDialog::clear_filters() {
  1062. filters.clear();
  1063. update_filters();
  1064. invalidate();
  1065. }
  1066. void FileDialog::add_filter(const String &p_filter, const String &p_description, const String &p_mime) {
  1067. ERR_FAIL_COND_MSG(p_filter.begins_with("."), "Filter must be \"filename.extension\", can't start with dot.");
  1068. if (p_description.is_empty() && p_mime.is_empty()) {
  1069. filters.push_back(p_filter);
  1070. } else if (p_mime.is_empty()) {
  1071. filters.push_back(vformat("%s ; %s", p_filter, p_description));
  1072. } else {
  1073. filters.push_back(vformat("%s ; %s ; %s", p_filter, p_description, p_mime));
  1074. }
  1075. update_filters();
  1076. invalidate();
  1077. }
  1078. void FileDialog::set_filters(const Vector<String> &p_filters) {
  1079. if (filters == p_filters) {
  1080. return;
  1081. }
  1082. filters = p_filters;
  1083. update_filters();
  1084. invalidate();
  1085. }
  1086. void FileDialog::set_filename_filter(const String &p_filename_filter) {
  1087. if (file_name_filter == p_filename_filter) {
  1088. return;
  1089. }
  1090. file_name_filter = p_filename_filter;
  1091. update_filename_filter_gui();
  1092. emit_signal(SNAME("filename_filter_changed"), filter);
  1093. invalidate();
  1094. }
  1095. Vector<String> FileDialog::get_filters() const {
  1096. return filters;
  1097. }
  1098. String FileDialog::get_filename_filter() const {
  1099. return file_name_filter;
  1100. }
  1101. String FileDialog::get_current_dir() const {
  1102. return full_dir;
  1103. }
  1104. String FileDialog::get_current_file() const {
  1105. return filename_edit->get_text();
  1106. }
  1107. String FileDialog::get_current_path() const {
  1108. return full_dir.path_join(filename_edit->get_text());
  1109. }
  1110. void FileDialog::set_current_dir(const String &p_dir) {
  1111. _change_dir(p_dir);
  1112. _push_history();
  1113. }
  1114. void FileDialog::set_current_file(const String &p_file) {
  1115. if (filename_edit->get_text() == p_file) {
  1116. return;
  1117. }
  1118. filename_edit->set_text(p_file);
  1119. update_dir();
  1120. invalidate();
  1121. _focus_file_text();
  1122. }
  1123. void FileDialog::set_current_path(const String &p_path) {
  1124. if (!p_path.size()) {
  1125. return;
  1126. }
  1127. int pos = MAX(p_path.rfind_char('/'), p_path.rfind_char('\\'));
  1128. if (pos == -1) {
  1129. set_current_file(p_path);
  1130. } else {
  1131. String path_dir = p_path.substr(0, pos);
  1132. String path_file = p_path.substr(pos + 1);
  1133. set_current_dir(path_dir);
  1134. set_current_file(path_file);
  1135. }
  1136. }
  1137. void FileDialog::set_root_subfolder(const String &p_root) {
  1138. root_subfolder = p_root;
  1139. ERR_FAIL_COND_MSG(!dir_access->dir_exists(p_root), "root_subfolder must be an existing sub-directory.");
  1140. local_history.clear();
  1141. local_history_pos = -1;
  1142. dir_access->change_dir(root_subfolder);
  1143. if (root_subfolder.is_empty()) {
  1144. root_prefix = "";
  1145. } else {
  1146. root_prefix = dir_access->get_current_dir();
  1147. }
  1148. invalidate();
  1149. update_dir();
  1150. }
  1151. String FileDialog::get_root_subfolder() const {
  1152. return root_subfolder;
  1153. }
  1154. void FileDialog::set_mode_overrides_title(bool p_override) {
  1155. mode_overrides_title = p_override;
  1156. }
  1157. bool FileDialog::is_mode_overriding_title() const {
  1158. return mode_overrides_title;
  1159. }
  1160. void FileDialog::set_file_mode(FileMode p_mode) {
  1161. ERR_FAIL_INDEX((int)p_mode, 5);
  1162. if (mode == p_mode) {
  1163. return;
  1164. }
  1165. mode = p_mode;
  1166. switch (mode) {
  1167. case FILE_MODE_OPEN_FILE:
  1168. set_default_ok_text(ETR("Open"));
  1169. if (mode_overrides_title) {
  1170. set_title(ETR("Open a File"));
  1171. }
  1172. break;
  1173. case FILE_MODE_OPEN_FILES:
  1174. set_default_ok_text(ETR("Open"));
  1175. if (mode_overrides_title) {
  1176. set_title(ETR("Open File(s)"));
  1177. }
  1178. break;
  1179. case FILE_MODE_OPEN_DIR:
  1180. set_default_ok_text(ETR("Select Current Folder"));
  1181. if (mode_overrides_title) {
  1182. set_title(ETR("Open a Directory"));
  1183. }
  1184. break;
  1185. case FILE_MODE_OPEN_ANY:
  1186. set_default_ok_text(ETR("Open"));
  1187. if (mode_overrides_title) {
  1188. set_title(ETR("Open a File or Directory"));
  1189. }
  1190. make_dir_button->show();
  1191. break;
  1192. case FILE_MODE_SAVE_FILE:
  1193. set_default_ok_text(ETR("Save"));
  1194. if (mode_overrides_title) {
  1195. set_title(ETR("Save a File"));
  1196. }
  1197. break;
  1198. }
  1199. _update_make_dir_visible();
  1200. if (mode == FILE_MODE_OPEN_FILES) {
  1201. file_list->set_select_mode(ItemList::SELECT_MULTI);
  1202. } else {
  1203. file_list->set_select_mode(ItemList::SELECT_SINGLE);
  1204. }
  1205. get_ok_button()->set_disabled(_is_open_should_be_disabled());
  1206. }
  1207. FileDialog::FileMode FileDialog::get_file_mode() const {
  1208. return mode;
  1209. }
  1210. void FileDialog::set_display_mode(DisplayMode p_mode) {
  1211. ERR_FAIL_INDEX((int)p_mode, DISPLAY_MAX);
  1212. if (display_mode == p_mode) {
  1213. return;
  1214. }
  1215. display_mode = p_mode;
  1216. if (p_mode == DISPLAY_THUMBNAILS) {
  1217. thumbnail_mode_button->set_pressed(true);
  1218. list_mode_button->set_pressed(false);
  1219. } else {
  1220. thumbnail_mode_button->set_pressed(false);
  1221. list_mode_button->set_pressed(true);
  1222. }
  1223. invalidate();
  1224. }
  1225. FileDialog::DisplayMode FileDialog::get_display_mode() const {
  1226. return display_mode;
  1227. }
  1228. void FileDialog::set_favorite_list(const PackedStringArray &p_favorites) {
  1229. ERR_FAIL_COND_MSG(Thread::get_caller_id() != Thread::get_main_id(), "Setting favorite list can only be done on the main thread.");
  1230. global_favorites.clear();
  1231. global_favorites.reserve(p_favorites.size());
  1232. for (const String &fav : p_favorites) {
  1233. if (fav.ends_with("/")) {
  1234. global_favorites.push_back(fav);
  1235. } else {
  1236. global_favorites.push_back(fav + "/");
  1237. }
  1238. }
  1239. }
  1240. PackedStringArray FileDialog::get_favorite_list() {
  1241. PackedStringArray ret;
  1242. ERR_FAIL_COND_V_MSG(Thread::get_caller_id() != Thread::get_main_id(), ret, "Getting favorite list can only be done on the main thread.");
  1243. ret.resize(global_favorites.size());
  1244. String *fav_write = ret.ptrw();
  1245. int i = 0;
  1246. for (const String &fav : global_favorites) {
  1247. fav_write[i] = fav;
  1248. i++;
  1249. }
  1250. return ret;
  1251. }
  1252. void FileDialog::set_recent_list(const PackedStringArray &p_recents) {
  1253. ERR_FAIL_COND_MSG(Thread::get_caller_id() != Thread::get_main_id(), "Setting recent list can only be done on the main thread.");
  1254. global_recents.clear();
  1255. global_recents.reserve(p_recents.size());
  1256. for (const String &recent : p_recents) {
  1257. if (recent.ends_with("/")) {
  1258. global_recents.push_back(recent);
  1259. } else {
  1260. global_recents.push_back(recent + "/");
  1261. }
  1262. }
  1263. }
  1264. PackedStringArray FileDialog::get_recent_list() {
  1265. PackedStringArray ret;
  1266. ERR_FAIL_COND_V_MSG(Thread::get_caller_id() != Thread::get_main_id(), ret, "Getting recent list can only be done on the main thread.");
  1267. ret.resize(global_recents.size());
  1268. String *recent_write = ret.ptrw();
  1269. int i = 0;
  1270. for (const String &recent : global_recents) {
  1271. recent_write[i] = recent;
  1272. i++;
  1273. }
  1274. return ret;
  1275. }
  1276. void FileDialog::set_customization_flag_enabled(Customization p_flag, bool p_enabled) {
  1277. ERR_FAIL_INDEX(p_flag, CUSTOMIZATION_MAX);
  1278. if (customization_flags[p_flag] == p_enabled) {
  1279. return;
  1280. }
  1281. customization_flags[p_flag] = p_enabled;
  1282. update_customization();
  1283. }
  1284. bool FileDialog::is_customization_flag_enabled(Customization p_flag) const {
  1285. ERR_FAIL_INDEX_V(p_flag, CUSTOMIZATION_MAX, false);
  1286. return customization_flags[p_flag];
  1287. }
  1288. void FileDialog::set_access(Access p_access) {
  1289. ERR_FAIL_INDEX(p_access, 3);
  1290. if (access == p_access) {
  1291. return;
  1292. }
  1293. access = p_access;
  1294. root_prefix = "";
  1295. root_subfolder = "";
  1296. switch (p_access) {
  1297. case ACCESS_FILESYSTEM: {
  1298. dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1299. #ifdef ANDROID_ENABLED
  1300. set_current_dir(OS::get_singleton()->get_system_dir(OS::SYSTEM_DIR_DESKTOP));
  1301. #endif
  1302. } break;
  1303. case ACCESS_RESOURCES: {
  1304. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  1305. } break;
  1306. case ACCESS_USERDATA: {
  1307. dir_access = DirAccess::create(DirAccess::ACCESS_USERDATA);
  1308. } break;
  1309. }
  1310. _update_drives();
  1311. invalidate();
  1312. update_filters();
  1313. update_dir();
  1314. _update_favorite_list();
  1315. _update_recent_list();
  1316. }
  1317. void FileDialog::invalidate() {
  1318. if (!is_visible() || is_invalidating) {
  1319. return;
  1320. }
  1321. is_invalidating = true;
  1322. callable_mp(this, &FileDialog::_invalidate).call_deferred();
  1323. }
  1324. void FileDialog::_invalidate() {
  1325. if (!is_invalidating) {
  1326. return;
  1327. }
  1328. update_file_list();
  1329. is_invalidating = false;
  1330. }
  1331. void FileDialog::_setup_button(Button *p_button, const Ref<Texture2D> &p_icon) {
  1332. p_button->set_button_icon(p_icon);
  1333. p_button->begin_bulk_theme_override();
  1334. p_button->add_theme_color_override(SNAME("icon_normal_color"), theme_cache.icon_normal_color);
  1335. p_button->add_theme_color_override(SNAME("icon_hover_color"), theme_cache.icon_hover_color);
  1336. p_button->add_theme_color_override(SNAME("icon_focus_color"), theme_cache.icon_focus_color);
  1337. p_button->add_theme_color_override(SNAME("icon_pressed_color"), theme_cache.icon_pressed_color);
  1338. p_button->end_bulk_theme_override();
  1339. }
  1340. void FileDialog::_update_make_dir_visible() {
  1341. can_create_folders = customization_flags[CUSTOMIZATION_CREATE_FOLDER] && mode != FILE_MODE_OPEN_FILE && mode != FILE_MODE_OPEN_FILES;
  1342. make_dir_container->set_visible(can_create_folders);
  1343. }
  1344. FileDialog::Access FileDialog::get_access() const {
  1345. return access;
  1346. }
  1347. void FileDialog::_make_dir_confirm() {
  1348. Error err = dir_access->make_dir(new_dir_name->get_text().strip_edges());
  1349. if (err == OK) {
  1350. _dir_contents_changed();
  1351. _change_dir(new_dir_name->get_text().strip_edges());
  1352. update_filters();
  1353. _push_history();
  1354. } else {
  1355. mkdirerr->popup_centered(Size2(250, 50));
  1356. }
  1357. new_dir_name->set_text(""); // reset label
  1358. }
  1359. void FileDialog::_make_dir() {
  1360. make_dir_dialog->popup_centered(Size2(250, 80));
  1361. new_dir_name->grab_focus();
  1362. }
  1363. void FileDialog::_select_drive(int p_idx) {
  1364. String d = drives->get_item_text(p_idx);
  1365. _change_dir(d);
  1366. filename_edit->set_text("");
  1367. _push_history();
  1368. }
  1369. void FileDialog::_change_dir(const String &p_new_dir) {
  1370. if (root_prefix.is_empty()) {
  1371. dir_access->change_dir(p_new_dir);
  1372. } else {
  1373. String old_dir = dir_access->get_current_dir();
  1374. dir_access->change_dir(p_new_dir);
  1375. if (!dir_access->get_current_dir().begins_with(root_prefix)) {
  1376. dir_access->change_dir(old_dir);
  1377. return;
  1378. }
  1379. }
  1380. invalidate();
  1381. update_dir();
  1382. }
  1383. void FileDialog::_update_drives(bool p_select) {
  1384. int dc = dir_access->get_drive_count();
  1385. if (dc == 0 || access != ACCESS_FILESYSTEM) {
  1386. drives->hide();
  1387. } else {
  1388. drives->clear();
  1389. Node *dp = drives->get_parent();
  1390. if (dp) {
  1391. dp->remove_child(drives);
  1392. }
  1393. dp = dir_access->drives_are_shortcuts() ? shortcuts_container : drives_container;
  1394. dp->add_child(drives);
  1395. drives->show();
  1396. for (int i = 0; i < dir_access->get_drive_count(); i++) {
  1397. drives->add_item(dir_access->get_drive(i));
  1398. }
  1399. if (p_select) {
  1400. drives->select(dir_access->get_current_drive());
  1401. }
  1402. }
  1403. }
  1404. void FileDialog::_sort_option_selected(int p_option) {
  1405. for (int i = 0; i < int(FileSortOption::MAX); i++) {
  1406. file_sort_button->get_popup()->set_item_checked(i, (i == p_option));
  1407. }
  1408. file_sort = FileSortOption(p_option);
  1409. invalidate();
  1410. }
  1411. void FileDialog::_favorite_selected(int p_item) {
  1412. ERR_FAIL_UNSIGNED_INDEX((uint32_t)p_item, global_favorites.size());
  1413. _change_dir(favorite_list->get_item_metadata(p_item));
  1414. _push_history();
  1415. }
  1416. void FileDialog::_favorite_pressed() {
  1417. String directory = get_current_dir();
  1418. if (!directory.ends_with("/")) {
  1419. directory += "/";
  1420. }
  1421. bool found = false;
  1422. for (const String &name : global_favorites) {
  1423. if (!_path_matches_access(name)) {
  1424. continue;
  1425. }
  1426. if (name == directory) {
  1427. found = true;
  1428. break;
  1429. }
  1430. }
  1431. if (found) {
  1432. global_favorites.erase(directory);
  1433. } else {
  1434. global_favorites.push_back(directory);
  1435. }
  1436. _update_favorite_list();
  1437. }
  1438. void FileDialog::_favorite_move_up() {
  1439. int current = favorite_list->get_current();
  1440. if (current <= 0) {
  1441. return;
  1442. }
  1443. int a_idx = global_favorites.find(favorite_list->get_item_metadata(current - 1));
  1444. int b_idx = global_favorites.find(favorite_list->get_item_metadata(current));
  1445. if (a_idx == -1 || b_idx == -1) {
  1446. return;
  1447. }
  1448. SWAP(global_favorites[a_idx], global_favorites[b_idx]);
  1449. _update_favorite_list();
  1450. }
  1451. void FileDialog::_favorite_move_down() {
  1452. int current = favorite_list->get_current();
  1453. if (current == -1 || current >= favorite_list->get_item_count() - 1) {
  1454. return;
  1455. }
  1456. int a_idx = global_favorites.find(favorite_list->get_item_metadata(current));
  1457. int b_idx = global_favorites.find(favorite_list->get_item_metadata(current + 1));
  1458. if (a_idx == -1 || b_idx == -1) {
  1459. return;
  1460. }
  1461. SWAP(global_favorites[a_idx], global_favorites[b_idx]);
  1462. _update_favorite_list();
  1463. }
  1464. void FileDialog::_update_favorite_list() {
  1465. const String current = get_current_dir();
  1466. favorite_list->clear();
  1467. favorite_button->set_pressed(false);
  1468. Vector<String> favorited_paths;
  1469. Vector<String> favorited_names;
  1470. int current_favorite = -1;
  1471. for (uint32_t i = 0; i < global_favorites.size(); i++) {
  1472. String name = global_favorites[i];
  1473. if (!_path_matches_access(name)) {
  1474. continue;
  1475. }
  1476. if (!name.ends_with("/") || !name.begins_with(root_prefix)) {
  1477. continue;
  1478. }
  1479. if (!dir_access->dir_exists(name)) {
  1480. // Remove invalid directory from the list of favorited directories.
  1481. global_favorites.remove_at(i);
  1482. i--;
  1483. continue;
  1484. }
  1485. if (name == current) {
  1486. current_favorite = favorited_names.size();
  1487. }
  1488. favorited_paths.append(name);
  1489. // Compute favorite display text.
  1490. if (name == "res://" || name == "user://") {
  1491. name = "/";
  1492. } else {
  1493. if (current_favorite == -1 && name == current + "/") {
  1494. current_favorite = favorited_names.size();
  1495. }
  1496. name = name.trim_suffix("/");
  1497. name = name.get_file();
  1498. }
  1499. favorited_names.append(name);
  1500. }
  1501. // EditorNode::disambiguate_filenames(favorited_paths, favorited_names); // TODO Needs a non-editor method.
  1502. const int favorites_size = favorited_paths.size();
  1503. for (int i = 0; i < favorites_size; i++) {
  1504. favorite_list->add_item(favorited_names[i], theme_cache.folder);
  1505. favorite_list->set_item_tooltip(-1, favorited_paths[i]);
  1506. favorite_list->set_item_metadata(-1, favorited_paths[i]);
  1507. favorite_list->set_item_icon_modulate(-1, _get_folder_color(favorited_paths[i]));
  1508. if (i == current_favorite) {
  1509. favorite_button->set_pressed(true);
  1510. favorite_list->set_current(favorite_list->get_item_count() - 1);
  1511. recent_list->deselect_all();
  1512. }
  1513. }
  1514. _update_fav_buttons();
  1515. }
  1516. void FileDialog::_update_fav_buttons() {
  1517. const int current = favorite_list->get_current();
  1518. fav_up_button->set_disabled(current < 1);
  1519. fav_down_button->set_disabled(current == -1 || current >= favorite_list->get_item_count() - 1);
  1520. }
  1521. void FileDialog::_recent_selected(int p_item) {
  1522. ERR_FAIL_UNSIGNED_INDEX((uint32_t)p_item, global_recents.size());
  1523. _change_dir(recent_list->get_item_metadata(p_item));
  1524. _push_history();
  1525. }
  1526. void FileDialog::_save_to_recent() {
  1527. String directory = get_current_dir();
  1528. if (!directory.ends_with("/")) {
  1529. directory += "/";
  1530. }
  1531. int count = 0;
  1532. for (uint32_t i = 0; i < global_recents.size(); i++) {
  1533. const String &dir = global_recents[i];
  1534. if (!_path_matches_access(dir)) {
  1535. continue;
  1536. }
  1537. if (dir == directory || count > MAX_RECENTS) {
  1538. global_recents.remove_at(i);
  1539. i--;
  1540. } else {
  1541. count++;
  1542. }
  1543. }
  1544. global_recents.insert(0, directory);
  1545. _update_recent_list();
  1546. }
  1547. void FileDialog::_update_recent_list() {
  1548. recent_list->clear();
  1549. Vector<String> recent_dir_paths;
  1550. Vector<String> recent_dir_names;
  1551. for (uint32_t i = 0; i < global_recents.size(); i++) {
  1552. String name = global_recents[i];
  1553. if (!_path_matches_access(name)) {
  1554. continue;
  1555. }
  1556. if (!name.begins_with(root_prefix)) {
  1557. continue;
  1558. }
  1559. if (!dir_access->dir_exists(name)) {
  1560. // Remove invalid directory from the list of recent directories.
  1561. global_recents.remove_at(i);
  1562. i--;
  1563. continue;
  1564. }
  1565. recent_dir_paths.append(name);
  1566. // Compute recent directory display text.
  1567. if (name == "res://" || name == "user://") {
  1568. name = "/";
  1569. } else {
  1570. name = name.trim_suffix("/").get_file();
  1571. }
  1572. recent_dir_names.append(name);
  1573. }
  1574. // EditorNode::disambiguate_filenames(recent_dir_paths, recent_dir_names); // TODO Needs a non-editor method.
  1575. const int recent_size = recent_dir_paths.size();
  1576. for (int i = 0; i < recent_size; i++) {
  1577. recent_list->add_item(recent_dir_names[i], theme_cache.folder);
  1578. recent_list->set_item_tooltip(-1, recent_dir_paths[i]);
  1579. recent_list->set_item_metadata(-1, recent_dir_paths[i]);
  1580. recent_list->set_item_icon_modulate(-1, _get_folder_color(recent_dir_paths[i]));
  1581. }
  1582. }
  1583. bool FileDialog::_path_matches_access(const String &p_path) const {
  1584. bool is_res = p_path.begins_with("res://");
  1585. bool is_user = p_path.begins_with("user://");
  1586. if (access == ACCESS_RESOURCES) {
  1587. return is_res;
  1588. } else if (access == ACCESS_USERDATA) {
  1589. return is_user;
  1590. }
  1591. return !is_res && !is_user;
  1592. }
  1593. TypedArray<Dictionary> FileDialog::_get_options() const {
  1594. TypedArray<Dictionary> out;
  1595. for (const FileDialog::Option &opt : options) {
  1596. Dictionary dict;
  1597. dict["name"] = opt.name;
  1598. dict["values"] = opt.values;
  1599. dict["default"] = (int)selected_options.get(opt.name, opt.default_idx);
  1600. out.push_back(dict);
  1601. }
  1602. return out;
  1603. }
  1604. void FileDialog::_option_changed_checkbox_toggled(bool p_pressed, const String &p_name) {
  1605. if (selected_options.has(p_name)) {
  1606. selected_options[p_name] = p_pressed;
  1607. }
  1608. }
  1609. void FileDialog::_option_changed_item_selected(int p_idx, const String &p_name) {
  1610. if (selected_options.has(p_name)) {
  1611. selected_options[p_name] = p_idx;
  1612. }
  1613. }
  1614. void FileDialog::_update_option_controls() {
  1615. if (!options_dirty) {
  1616. return;
  1617. }
  1618. options_dirty = false;
  1619. while (flow_checkbox_options->get_child_count() > 0) {
  1620. Node *child = flow_checkbox_options->get_child(0);
  1621. flow_checkbox_options->remove_child(child);
  1622. child->queue_free();
  1623. }
  1624. while (grid_select_options->get_child_count() > 0) {
  1625. Node *child = grid_select_options->get_child(0);
  1626. grid_select_options->remove_child(child);
  1627. child->queue_free();
  1628. }
  1629. selected_options.clear();
  1630. for (const FileDialog::Option &opt : options) {
  1631. if (opt.values.is_empty()) {
  1632. CheckBox *cb = memnew(CheckBox);
  1633. cb->set_text(opt.name);
  1634. cb->set_accessibility_name(opt.name);
  1635. cb->set_pressed(opt.default_idx);
  1636. flow_checkbox_options->add_child(cb);
  1637. cb->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::_option_changed_checkbox_toggled).bind(opt.name));
  1638. selected_options[opt.name] = (bool)opt.default_idx;
  1639. } else {
  1640. Label *lbl = memnew(Label);
  1641. lbl->set_text(opt.name);
  1642. grid_select_options->add_child(lbl);
  1643. OptionButton *ob = memnew(OptionButton);
  1644. for (const String &val : opt.values) {
  1645. ob->add_item(val);
  1646. }
  1647. ob->set_accessibility_name(opt.name);
  1648. ob->select(opt.default_idx);
  1649. grid_select_options->add_child(ob);
  1650. ob->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_option_changed_item_selected).bind(opt.name));
  1651. selected_options[opt.name] = opt.default_idx;
  1652. }
  1653. }
  1654. }
  1655. Dictionary FileDialog::get_selected_options() const {
  1656. return selected_options;
  1657. }
  1658. String FileDialog::get_option_name(int p_option) const {
  1659. ERR_FAIL_INDEX_V(p_option, options.size(), String());
  1660. return options[p_option].name;
  1661. }
  1662. Vector<String> FileDialog::get_option_values(int p_option) const {
  1663. ERR_FAIL_INDEX_V(p_option, options.size(), Vector<String>());
  1664. return options[p_option].values;
  1665. }
  1666. int FileDialog::get_option_default(int p_option) const {
  1667. ERR_FAIL_INDEX_V(p_option, options.size(), -1);
  1668. return options[p_option].default_idx;
  1669. }
  1670. void FileDialog::set_option_name(int p_option, const String &p_name) {
  1671. if (p_option < 0) {
  1672. p_option += get_option_count();
  1673. }
  1674. ERR_FAIL_INDEX(p_option, options.size());
  1675. options.write[p_option].name = p_name;
  1676. options_dirty = true;
  1677. if (is_visible()) {
  1678. _update_option_controls();
  1679. }
  1680. }
  1681. void FileDialog::set_option_values(int p_option, const Vector<String> &p_values) {
  1682. if (p_option < 0) {
  1683. p_option += get_option_count();
  1684. }
  1685. ERR_FAIL_INDEX(p_option, options.size());
  1686. options.write[p_option].values = p_values;
  1687. if (p_values.is_empty()) {
  1688. options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, 1);
  1689. } else {
  1690. options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, options[p_option].values.size() - 1);
  1691. }
  1692. options_dirty = true;
  1693. if (is_visible()) {
  1694. _update_option_controls();
  1695. }
  1696. }
  1697. void FileDialog::set_option_default(int p_option, int p_index) {
  1698. if (p_option < 0) {
  1699. p_option += get_option_count();
  1700. }
  1701. ERR_FAIL_INDEX(p_option, options.size());
  1702. if (options[p_option].values.is_empty()) {
  1703. options.write[p_option].default_idx = CLAMP(p_index, 0, 1);
  1704. } else {
  1705. options.write[p_option].default_idx = CLAMP(p_index, 0, options[p_option].values.size() - 1);
  1706. }
  1707. options_dirty = true;
  1708. if (is_visible()) {
  1709. _update_option_controls();
  1710. }
  1711. }
  1712. void FileDialog::add_option(const String &p_name, const Vector<String> &p_values, int p_index) {
  1713. Option opt;
  1714. opt.name = p_name;
  1715. opt.values = p_values;
  1716. if (opt.values.is_empty()) {
  1717. opt.default_idx = CLAMP(p_index, 0, 1);
  1718. } else {
  1719. opt.default_idx = CLAMP(p_index, 0, opt.values.size() - 1);
  1720. }
  1721. options.push_back(opt);
  1722. options_dirty = true;
  1723. if (is_visible()) {
  1724. _update_option_controls();
  1725. }
  1726. }
  1727. void FileDialog::set_option_count(int p_count) {
  1728. ERR_FAIL_COND(p_count < 0);
  1729. if (options.size() == p_count) {
  1730. return;
  1731. }
  1732. options.resize(p_count);
  1733. options_dirty = true;
  1734. notify_property_list_changed();
  1735. if (is_visible()) {
  1736. _update_option_controls();
  1737. }
  1738. }
  1739. int FileDialog::get_option_count() const {
  1740. return options.size();
  1741. }
  1742. void FileDialog::_bind_methods() {
  1743. ClassDB::bind_method(D_METHOD("_cancel_pressed"), &FileDialog::_cancel_pressed);
  1744. ClassDB::bind_method(D_METHOD("clear_filters"), &FileDialog::clear_filters);
  1745. ClassDB::bind_method(D_METHOD("add_filter", "filter", "description", "mime_type"), &FileDialog::add_filter, DEFVAL(""), DEFVAL(""));
  1746. ClassDB::bind_method(D_METHOD("set_filters", "filters"), &FileDialog::set_filters);
  1747. ClassDB::bind_method(D_METHOD("get_filters"), &FileDialog::get_filters);
  1748. ClassDB::bind_method(D_METHOD("clear_filename_filter"), &FileDialog::clear_filename_filter);
  1749. ClassDB::bind_method(D_METHOD("set_filename_filter", "filter"), &FileDialog::set_filename_filter);
  1750. ClassDB::bind_method(D_METHOD("get_filename_filter"), &FileDialog::get_filename_filter);
  1751. ClassDB::bind_method(D_METHOD("get_option_name", "option"), &FileDialog::get_option_name);
  1752. ClassDB::bind_method(D_METHOD("get_option_values", "option"), &FileDialog::get_option_values);
  1753. ClassDB::bind_method(D_METHOD("get_option_default", "option"), &FileDialog::get_option_default);
  1754. ClassDB::bind_method(D_METHOD("set_option_name", "option", "name"), &FileDialog::set_option_name);
  1755. ClassDB::bind_method(D_METHOD("set_option_values", "option", "values"), &FileDialog::set_option_values);
  1756. ClassDB::bind_method(D_METHOD("set_option_default", "option", "default_value_index"), &FileDialog::set_option_default);
  1757. ClassDB::bind_method(D_METHOD("set_option_count", "count"), &FileDialog::set_option_count);
  1758. ClassDB::bind_method(D_METHOD("get_option_count"), &FileDialog::get_option_count);
  1759. ClassDB::bind_method(D_METHOD("add_option", "name", "values", "default_value_index"), &FileDialog::add_option);
  1760. ClassDB::bind_method(D_METHOD("get_selected_options"), &FileDialog::get_selected_options);
  1761. ClassDB::bind_method(D_METHOD("get_current_dir"), &FileDialog::get_current_dir);
  1762. ClassDB::bind_method(D_METHOD("get_current_file"), &FileDialog::get_current_file);
  1763. ClassDB::bind_method(D_METHOD("get_current_path"), &FileDialog::get_current_path);
  1764. ClassDB::bind_method(D_METHOD("set_current_dir", "dir"), &FileDialog::set_current_dir);
  1765. ClassDB::bind_method(D_METHOD("set_current_file", "file"), &FileDialog::set_current_file);
  1766. ClassDB::bind_method(D_METHOD("set_current_path", "path"), &FileDialog::set_current_path);
  1767. ClassDB::bind_method(D_METHOD("set_mode_overrides_title", "override"), &FileDialog::set_mode_overrides_title);
  1768. ClassDB::bind_method(D_METHOD("is_mode_overriding_title"), &FileDialog::is_mode_overriding_title);
  1769. ClassDB::bind_method(D_METHOD("set_file_mode", "mode"), &FileDialog::set_file_mode);
  1770. ClassDB::bind_method(D_METHOD("get_file_mode"), &FileDialog::get_file_mode);
  1771. ClassDB::bind_method(D_METHOD("set_display_mode", "mode"), &FileDialog::set_display_mode);
  1772. ClassDB::bind_method(D_METHOD("get_display_mode"), &FileDialog::get_display_mode);
  1773. ClassDB::bind_method(D_METHOD("get_vbox"), &FileDialog::get_vbox);
  1774. ClassDB::bind_method(D_METHOD("get_line_edit"), &FileDialog::get_line_edit);
  1775. ClassDB::bind_method(D_METHOD("set_access", "access"), &FileDialog::set_access);
  1776. ClassDB::bind_method(D_METHOD("get_access"), &FileDialog::get_access);
  1777. ClassDB::bind_method(D_METHOD("set_root_subfolder", "dir"), &FileDialog::set_root_subfolder);
  1778. ClassDB::bind_method(D_METHOD("get_root_subfolder"), &FileDialog::get_root_subfolder);
  1779. ClassDB::bind_method(D_METHOD("set_show_hidden_files", "show"), &FileDialog::set_show_hidden_files);
  1780. ClassDB::bind_method(D_METHOD("is_showing_hidden_files"), &FileDialog::is_showing_hidden_files);
  1781. ClassDB::bind_method(D_METHOD("set_use_native_dialog", "native"), &FileDialog::set_use_native_dialog);
  1782. ClassDB::bind_method(D_METHOD("get_use_native_dialog"), &FileDialog::get_use_native_dialog);
  1783. ClassDB::bind_method(D_METHOD("set_customization_flag_enabled", "flag", "enabled"), &FileDialog::set_customization_flag_enabled);
  1784. ClassDB::bind_method(D_METHOD("is_customization_flag_enabled", "flag"), &FileDialog::is_customization_flag_enabled);
  1785. ClassDB::bind_method(D_METHOD("deselect_all"), &FileDialog::deselect_all);
  1786. ClassDB::bind_static_method("FileDialog", D_METHOD("set_favorite_list", "favorites"), &FileDialog::set_favorite_list);
  1787. ClassDB::bind_static_method("FileDialog", D_METHOD("get_favorite_list"), &FileDialog::get_favorite_list);
  1788. ClassDB::bind_static_method("FileDialog", D_METHOD("set_recent_list", "recents"), &FileDialog::set_recent_list);
  1789. ClassDB::bind_static_method("FileDialog", D_METHOD("get_recent_list"), &FileDialog::get_recent_list);
  1790. ClassDB::bind_static_method("FileDialog", D_METHOD("set_get_icon_callback", "callback"), &FileDialog::set_get_icon_callback);
  1791. ClassDB::bind_static_method("FileDialog", D_METHOD("set_get_thumbnail_callback", "callback"), &FileDialog::set_get_thumbnail_callback);
  1792. ClassDB::bind_method(D_METHOD("popup_file_dialog"), &FileDialog::popup_file_dialog);
  1793. ClassDB::bind_method(D_METHOD("invalidate"), &FileDialog::invalidate);
  1794. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "mode_overrides_title"), "set_mode_overrides_title", "is_mode_overriding_title");
  1795. 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");
  1796. ADD_PROPERTY(PropertyInfo(Variant::INT, "display_mode", PROPERTY_HINT_ENUM, "Thumbnails,List"), "set_display_mode", "get_display_mode");
  1797. ADD_PROPERTY(PropertyInfo(Variant::INT, "access", PROPERTY_HINT_ENUM, "Resources,User Data,File System"), "set_access", "get_access");
  1798. ADD_PROPERTY(PropertyInfo(Variant::STRING, "root_subfolder"), "set_root_subfolder", "get_root_subfolder");
  1799. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "filters"), "set_filters", "get_filters");
  1800. ADD_PROPERTY(PropertyInfo(Variant::STRING, "filename_filter"), "set_filename_filter", "get_filename_filter");
  1801. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "show_hidden_files"), "set_show_hidden_files", "is_showing_hidden_files");
  1802. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "use_native_dialog"), "set_use_native_dialog", "get_use_native_dialog");
  1803. ADD_ARRAY_COUNT("Options", "option_count", "set_option_count", "get_option_count", "option_");
  1804. ADD_GROUP("Customization", "");
  1805. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "hidden_files_toggle_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_HIDDEN_FILES);
  1806. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "file_filter_toggle_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_FILE_FILTER);
  1807. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "file_sort_options_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_FILE_SORT);
  1808. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "folder_creation_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_CREATE_FOLDER);
  1809. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "favorites_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_FAVORITES);
  1810. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "recent_list_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_RECENT);
  1811. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "layout_toggle_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_LAYOUT);
  1812. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "overwrite_warning_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_OVERWRITE_WARNING);
  1813. ADD_PROPERTYI(PropertyInfo(Variant::BOOL, "deleting_enabled"), "set_customization_flag_enabled", "is_customization_flag_enabled", CUSTOMIZATION_DELETE);
  1814. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_dir", PROPERTY_HINT_DIR, "", PROPERTY_USAGE_NONE), "set_current_dir", "get_current_dir");
  1815. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_file", PROPERTY_HINT_FILE_PATH, "*", PROPERTY_USAGE_NONE), "set_current_file", "get_current_file");
  1816. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_current_path", "get_current_path");
  1817. ADD_SIGNAL(MethodInfo("file_selected", PropertyInfo(Variant::STRING, "path")));
  1818. ADD_SIGNAL(MethodInfo("files_selected", PropertyInfo(Variant::PACKED_STRING_ARRAY, "paths")));
  1819. ADD_SIGNAL(MethodInfo("dir_selected", PropertyInfo(Variant::STRING, "dir")));
  1820. ADD_SIGNAL(MethodInfo("filename_filter_changed", PropertyInfo(Variant::STRING, "filter")));
  1821. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILE);
  1822. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILES);
  1823. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_DIR);
  1824. BIND_ENUM_CONSTANT(FILE_MODE_OPEN_ANY);
  1825. BIND_ENUM_CONSTANT(FILE_MODE_SAVE_FILE);
  1826. BIND_ENUM_CONSTANT(ACCESS_RESOURCES);
  1827. BIND_ENUM_CONSTANT(ACCESS_USERDATA);
  1828. BIND_ENUM_CONSTANT(ACCESS_FILESYSTEM);
  1829. BIND_ENUM_CONSTANT(DISPLAY_THUMBNAILS);
  1830. BIND_ENUM_CONSTANT(DISPLAY_LIST);
  1831. BIND_ENUM_CONSTANT(CUSTOMIZATION_HIDDEN_FILES);
  1832. BIND_ENUM_CONSTANT(CUSTOMIZATION_CREATE_FOLDER);
  1833. BIND_ENUM_CONSTANT(CUSTOMIZATION_FILE_FILTER);
  1834. BIND_ENUM_CONSTANT(CUSTOMIZATION_FILE_SORT);
  1835. BIND_ENUM_CONSTANT(CUSTOMIZATION_FAVORITES);
  1836. BIND_ENUM_CONSTANT(CUSTOMIZATION_RECENT);
  1837. BIND_ENUM_CONSTANT(CUSTOMIZATION_LAYOUT);
  1838. BIND_ENUM_CONSTANT(CUSTOMIZATION_OVERWRITE_WARNING);
  1839. BIND_ENUM_CONSTANT(CUSTOMIZATION_DELETE);
  1840. BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, FileDialog, thumbnail_size);
  1841. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, parent_folder);
  1842. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, forward_folder);
  1843. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, back_folder);
  1844. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, reload);
  1845. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, favorite);
  1846. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, toggle_hidden);
  1847. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, folder);
  1848. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, toggle_filename_filter);
  1849. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, file);
  1850. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, create_folder);
  1851. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, sort);
  1852. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, favorite_up);
  1853. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, favorite_down);
  1854. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, thumbnail_mode);
  1855. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, list_mode);
  1856. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, file_thumbnail);
  1857. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, folder_thumbnail);
  1858. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, folder_icon_color);
  1859. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_icon_color);
  1860. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_disabled_color);
  1861. // TODO: Define own colors?
  1862. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_normal_color, "font_color", "Button");
  1863. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_hover_color, "font_hover_color", "Button");
  1864. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_focus_color, "font_focus_color", "Button");
  1865. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_pressed_color, "font_pressed_color", "Button");
  1866. Option defaults;
  1867. base_property_helper.set_prefix("option_");
  1868. base_property_helper.set_array_length_getter(&FileDialog::get_option_count);
  1869. base_property_helper.register_property(PropertyInfo(Variant::STRING, "name"), defaults.name, &FileDialog::set_option_name, &FileDialog::get_option_name);
  1870. base_property_helper.register_property(PropertyInfo(Variant::PACKED_STRING_ARRAY, "values"), defaults.values, &FileDialog::set_option_values, &FileDialog::get_option_values);
  1871. base_property_helper.register_property(PropertyInfo(Variant::INT, "default"), defaults.default_idx, &FileDialog::set_option_default, &FileDialog::get_option_default);
  1872. PropertyListHelper::register_base_helper(&base_property_helper);
  1873. ADD_CLASS_DEPENDENCY("Button");
  1874. ADD_CLASS_DEPENDENCY("ConfirmationDialog");
  1875. ADD_CLASS_DEPENDENCY("LineEdit");
  1876. ADD_CLASS_DEPENDENCY("OptionButton");
  1877. ADD_CLASS_DEPENDENCY("Tree");
  1878. }
  1879. void FileDialog::set_show_hidden_files(bool p_show) {
  1880. if (show_hidden_files == p_show) {
  1881. return;
  1882. }
  1883. show_hidden_files = p_show;
  1884. invalidate();
  1885. }
  1886. void FileDialog::set_show_filename_filter(bool p_show) {
  1887. if (p_show == show_filename_filter) {
  1888. return;
  1889. }
  1890. if (p_show) {
  1891. filename_filter->grab_focus();
  1892. } else {
  1893. if (filename_filter->has_focus()) {
  1894. callable_mp((Control *)file_list, &Control::grab_focus).call_deferred(false);
  1895. }
  1896. }
  1897. show_filename_filter = p_show;
  1898. update_filename_filter_gui();
  1899. invalidate();
  1900. }
  1901. bool FileDialog::get_show_filename_filter() const {
  1902. return show_filename_filter;
  1903. }
  1904. bool FileDialog::is_showing_hidden_files() const {
  1905. return show_hidden_files;
  1906. }
  1907. void FileDialog::set_default_show_hidden_files(bool p_show) {
  1908. default_show_hidden_files = p_show;
  1909. }
  1910. void FileDialog::set_default_display_mode(DisplayMode p_mode) {
  1911. default_display_mode = p_mode;
  1912. }
  1913. void FileDialog::set_get_icon_callback(const Callable &p_callback) {
  1914. get_icon_callback = p_callback;
  1915. }
  1916. void FileDialog::set_get_thumbnail_callback(const Callable &p_callback) {
  1917. get_thumbnail_callback = p_callback;
  1918. }
  1919. void FileDialog::set_use_native_dialog(bool p_native) {
  1920. use_native_dialog = p_native;
  1921. #ifdef TOOLS_ENABLED
  1922. if (is_part_of_edited_scene()) {
  1923. return;
  1924. }
  1925. #endif
  1926. // Replace the built-in dialog with the native one if it's currently visible.
  1927. if (is_inside_tree() && is_visible() && _should_use_native_popup()) {
  1928. ConfirmationDialog::set_visible(false);
  1929. _native_popup();
  1930. }
  1931. }
  1932. bool FileDialog::get_use_native_dialog() const {
  1933. return use_native_dialog;
  1934. }
  1935. FileDialog::FileDialog() {
  1936. set_title(ETR("Save a File"));
  1937. set_hide_on_ok(false);
  1938. set_size(Size2(640, 360));
  1939. set_default_ok_text(ETR("Save")); // Default mode text.
  1940. set_process_shortcut_input(true);
  1941. for (int i = 0; i < CUSTOMIZATION_MAX; i++) {
  1942. customization_flags[i] = true;
  1943. }
  1944. action_shortcuts[ITEM_MENU_DELETE] = Shortcut::make_from_action("ui_filedialog_delete");
  1945. action_shortcuts[ITEM_MENU_GO_UP] = Shortcut::make_from_action("ui_filedialog_up_one_level");
  1946. action_shortcuts[ITEM_MENU_REFRESH] = Shortcut::make_from_action("ui_filedialog_refresh");
  1947. action_shortcuts[ITEM_MENU_TOGGLE_HIDDEN] = Shortcut::make_from_action("ui_filedialog_show_hidden");
  1948. action_shortcuts[ITEM_MENU_FIND] = Shortcut::make_from_action("ui_filedialog_find");
  1949. action_shortcuts[ITEM_MENU_FOCUS_PATH] = Shortcut::make_from_action("ui_filedialog_focus_path");
  1950. show_hidden_files = default_show_hidden_files;
  1951. display_mode = default_display_mode;
  1952. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  1953. main_vbox = memnew(VBoxContainer);
  1954. add_child(main_vbox, false, INTERNAL_MODE_FRONT);
  1955. HBoxContainer *top_toolbar = memnew(HBoxContainer);
  1956. main_vbox->add_child(top_toolbar);
  1957. dir_prev = memnew(Button);
  1958. dir_prev->set_theme_type_variation(SceneStringName(FlatButton));
  1959. dir_prev->set_tooltip_text(ETR("Go to previous folder."));
  1960. top_toolbar->add_child(dir_prev);
  1961. dir_prev->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_back));
  1962. dir_next = memnew(Button);
  1963. dir_next->set_theme_type_variation(SceneStringName(FlatButton));
  1964. dir_next->set_tooltip_text(ETR("Go to next folder."));
  1965. top_toolbar->add_child(dir_next);
  1966. dir_next->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_forward));
  1967. dir_up = memnew(Button);
  1968. dir_up->set_theme_type_variation(SceneStringName(FlatButton));
  1969. dir_up->set_tooltip_text(ETR("Go to parent folder."));
  1970. dir_up->set_shortcut(action_shortcuts[ITEM_MENU_GO_UP]);
  1971. top_toolbar->add_child(dir_up);
  1972. dir_up->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_up));
  1973. {
  1974. Label *label = memnew(Label(ETR("Path:")));
  1975. top_toolbar->add_child(label);
  1976. }
  1977. drives_container = memnew(HBoxContainer);
  1978. top_toolbar->add_child(drives_container);
  1979. drives = memnew(OptionButton);
  1980. drives->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_select_drive));
  1981. drives->set_accessibility_name(ETR("Drive"));
  1982. top_toolbar->add_child(drives);
  1983. directory_edit = memnew(LineEdit);
  1984. directory_edit->set_accessibility_name(ETR("Path:"));
  1985. directory_edit->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  1986. directory_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1987. top_toolbar->add_child(directory_edit);
  1988. directory_edit->connect(SceneStringName(text_submitted), callable_mp(this, &FileDialog::_dir_submitted));
  1989. shortcuts_container = memnew(HBoxContainer);
  1990. top_toolbar->add_child(shortcuts_container);
  1991. refresh_button = memnew(Button);
  1992. refresh_button->set_theme_type_variation(SceneStringName(FlatButton));
  1993. refresh_button->set_tooltip_text(ETR("Refresh files."));
  1994. refresh_button->set_shortcut(action_shortcuts[ITEM_MENU_REFRESH]);
  1995. top_toolbar->add_child(refresh_button);
  1996. refresh_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::update_file_list));
  1997. favorite_button = memnew(Button);
  1998. favorite_button->set_theme_type_variation(SceneStringName(FlatButton));
  1999. favorite_button->set_tooltip_text(ETR("(Un)favorite current folder."));
  2000. top_toolbar->add_child(favorite_button);
  2001. favorite_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_favorite_pressed));
  2002. make_dir_container = memnew(HBoxContainer);
  2003. top_toolbar->add_child(make_dir_container);
  2004. make_dir_container->add_child(memnew(VSeparator));
  2005. make_dir_button = memnew(Button);
  2006. make_dir_button->set_theme_type_variation(SceneStringName(FlatButton));
  2007. make_dir_button->set_tooltip_text(ETR("Create a new folder."));
  2008. make_dir_container->add_child(make_dir_button);
  2009. make_dir_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_make_dir));
  2010. HSplitContainer *main_split = memnew(HSplitContainer);
  2011. main_split->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2012. main_vbox->add_child(main_split);
  2013. {
  2014. VSplitContainer *fav_split = memnew(VSplitContainer);
  2015. main_split->add_child(fav_split);
  2016. favorite_vbox = memnew(VBoxContainer);
  2017. favorite_vbox->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2018. fav_split->add_child(favorite_vbox);
  2019. HBoxContainer *fav_hbox = memnew(HBoxContainer);
  2020. favorite_vbox->add_child(fav_hbox);
  2021. {
  2022. Label *label = memnew(Label(ETR("Favorites:")));
  2023. label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2024. label->set_theme_type_variation("HeaderSmall");
  2025. fav_hbox->add_child(label);
  2026. }
  2027. fav_up_button = memnew(Button);
  2028. fav_up_button->set_theme_type_variation(SceneStringName(FlatButton));
  2029. fav_hbox->add_child(fav_up_button);
  2030. fav_up_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_favorite_move_up));
  2031. fav_down_button = memnew(Button);
  2032. fav_down_button->set_theme_type_variation(SceneStringName(FlatButton));
  2033. fav_hbox->add_child(fav_down_button);
  2034. fav_down_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_favorite_move_down));
  2035. favorite_list = memnew(ItemList);
  2036. favorite_list->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2037. favorite_list->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  2038. favorite_list->set_theme_type_variation("ItemListSecondary");
  2039. favorite_list->set_accessibility_name(ETR("Favorites:"));
  2040. favorite_vbox->add_child(favorite_list);
  2041. favorite_list->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_favorite_selected));
  2042. recent_vbox = memnew(VBoxContainer);
  2043. recent_vbox->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2044. fav_split->add_child(recent_vbox);
  2045. {
  2046. Label *label = memnew(Label(ETR("Recent:")));
  2047. label->set_theme_type_variation("HeaderSmall");
  2048. recent_vbox->add_child(label);
  2049. }
  2050. recent_list = memnew(ItemList);
  2051. recent_list->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2052. recent_list->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  2053. recent_list->set_theme_type_variation("ItemListSecondary");
  2054. recent_list->set_accessibility_name(ETR("Recent:"));
  2055. recent_vbox->add_child(recent_list);
  2056. recent_list->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_recent_selected));
  2057. }
  2058. VBoxContainer *file_vbox = memnew(VBoxContainer);
  2059. main_split->add_child(file_vbox);
  2060. HBoxContainer *lower_toolbar = memnew(HBoxContainer);
  2061. file_vbox->add_child(lower_toolbar);
  2062. {
  2063. Label *label = memnew(Label(ETR("Directories & Files:")));
  2064. label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2065. label->set_theme_type_variation("HeaderSmall");
  2066. lower_toolbar->add_child(label);
  2067. }
  2068. show_hidden = memnew(Button);
  2069. show_hidden->set_theme_type_variation(SceneStringName(FlatButton));
  2070. show_hidden->set_toggle_mode(true);
  2071. show_hidden->set_pressed(is_showing_hidden_files());
  2072. show_hidden->set_tooltip_text(ETR("Toggle the visibility of hidden files."));
  2073. show_hidden->set_shortcut(action_shortcuts[ITEM_MENU_TOGGLE_HIDDEN]);
  2074. lower_toolbar->add_child(show_hidden);
  2075. show_hidden->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::set_show_hidden_files));
  2076. show_hidden_separator = memnew(VSeparator);
  2077. lower_toolbar->add_child(show_hidden_separator);
  2078. layout_container = memnew(HBoxContainer);
  2079. lower_toolbar->add_child(layout_container);
  2080. Ref<ButtonGroup> view_mode_group;
  2081. view_mode_group.instantiate();
  2082. thumbnail_mode_button = memnew(Button);
  2083. thumbnail_mode_button->set_toggle_mode(true);
  2084. thumbnail_mode_button->set_pressed(true);
  2085. thumbnail_mode_button->set_button_group(view_mode_group);
  2086. thumbnail_mode_button->set_theme_type_variation(SceneStringName(FlatButton));
  2087. thumbnail_mode_button->set_tooltip_text(ETR("View items as a grid of thumbnails."));
  2088. layout_container->add_child(thumbnail_mode_button);
  2089. thumbnail_mode_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::set_display_mode).bind(DISPLAY_THUMBNAILS));
  2090. list_mode_button = memnew(Button);
  2091. list_mode_button->set_toggle_mode(true);
  2092. list_mode_button->set_button_group(view_mode_group);
  2093. list_mode_button->set_theme_type_variation(SceneStringName(FlatButton));
  2094. list_mode_button->set_tooltip_text(ETR("View items as a list."));
  2095. layout_container->add_child(list_mode_button);
  2096. list_mode_button->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::set_display_mode).bind(DISPLAY_LIST));
  2097. layout_separator = memnew(VSeparator);
  2098. layout_container->add_child(layout_separator);
  2099. show_filename_filter_button = memnew(Button);
  2100. show_filename_filter_button->set_theme_type_variation(SceneStringName(FlatButton));
  2101. show_filename_filter_button->set_toggle_mode(true);
  2102. show_filename_filter_button->set_tooltip_text(ETR("Toggle the visibility of the filter for file names."));
  2103. show_filename_filter_button->set_shortcut(action_shortcuts[ITEM_MENU_FIND]);
  2104. lower_toolbar->add_child(show_filename_filter_button);
  2105. show_filename_filter_button->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::set_show_filename_filter));
  2106. file_sort_button = memnew(MenuButton);
  2107. file_sort_button->set_flat(false);
  2108. file_sort_button->set_theme_type_variation("FlatMenuButton");
  2109. file_sort_button->set_tooltip_text(ETR("Sort files"));
  2110. PopupMenu *sort_menu = file_sort_button->get_popup();
  2111. sort_menu->add_radio_check_item(ETR("Sort by Name (Ascending)"), int(FileSortOption::NAME));
  2112. sort_menu->add_radio_check_item(ETR("Sort by Name (Descending)"), int(FileSortOption::NAME_REVERSE));
  2113. sort_menu->add_radio_check_item(ETR("Sort by Type (Ascending)"), int(FileSortOption::TYPE));
  2114. sort_menu->add_radio_check_item(ETR("Sort by Type (Descending)"), int(FileSortOption::TYPE_REVERSE));
  2115. sort_menu->add_radio_check_item(ETR("Sort by Modified Time (Newest First)"), int(FileSortOption::MODIFIED_TIME));
  2116. sort_menu->add_radio_check_item(ETR("Sort by Modified Time (Oldest First)"), int(FileSortOption::MODIFIED_TIME_REVERSE));
  2117. sort_menu->set_item_checked(0, true);
  2118. lower_toolbar->add_child(file_sort_button);
  2119. sort_menu->connect(SceneStringName(id_pressed), callable_mp(this, &FileDialog::_sort_option_selected));
  2120. file_list = memnew(ItemList);
  2121. file_list->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  2122. file_list->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2123. file_list->set_theme_type_variation("ItemListSecondary");
  2124. file_list->set_accessibility_name(ETR("Directories & Files:"));
  2125. file_list->set_allow_rmb_select(true);
  2126. file_vbox->add_child(file_list);
  2127. file_list->connect("multi_selected", callable_mp(this, &FileDialog::_file_list_multi_selected));
  2128. file_list->connect("item_selected", callable_mp(this, &FileDialog::_file_list_selected));
  2129. file_list->connect("item_activated", callable_mp(this, &FileDialog::_file_list_item_activated));
  2130. file_list->connect("item_clicked", callable_mp(this, &FileDialog::_item_clicked));
  2131. file_list->connect("empty_clicked", callable_mp(this, &FileDialog::_empty_clicked));
  2132. message = memnew(Label);
  2133. message->set_focus_mode(Control::FOCUS_ACCESSIBILITY);
  2134. message->hide();
  2135. message->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  2136. message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  2137. message->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
  2138. file_list->add_child(message);
  2139. filename_filter_box = memnew(HBoxContainer);
  2140. filename_filter_box->set_visible(false);
  2141. file_vbox->add_child(filename_filter_box);
  2142. {
  2143. Label *label = memnew(Label(ETR("Filter:")));
  2144. filename_filter_box->add_child(label);
  2145. }
  2146. filename_filter = memnew(LineEdit);
  2147. filename_filter->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  2148. filename_filter->set_stretch_ratio(4);
  2149. filename_filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2150. filename_filter->set_clear_button_enabled(true);
  2151. filename_filter->set_accessibility_name(ETR("Filename Filter:"));
  2152. filename_filter_box->add_child(filename_filter);
  2153. filename_filter->connect(SceneStringName(text_changed), callable_mp(this, &FileDialog::_filename_filter_changed).unbind(1));
  2154. filename_filter->connect(SceneStringName(text_submitted), callable_mp(this, &FileDialog::_filename_filter_selected).unbind(1));
  2155. file_box = memnew(HBoxContainer);
  2156. file_vbox->add_child(file_box);
  2157. {
  2158. Label *label = memnew(Label(ETR("File:")));
  2159. file_box->add_child(label);
  2160. }
  2161. filename_edit = memnew(LineEdit);
  2162. filename_edit->set_accessibility_name(ETR("File:"));
  2163. filename_edit->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  2164. filename_edit->set_stretch_ratio(4);
  2165. filename_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2166. file_box->add_child(filename_edit);
  2167. filename_edit->connect(SceneStringName(text_submitted), callable_mp(this, &FileDialog::_action_pressed).unbind(1));
  2168. filter = memnew(OptionButton);
  2169. filter->set_stretch_ratio(3);
  2170. filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2171. filter->set_clip_text(true); // Too many extensions overflows it.
  2172. file_box->add_child(filter);
  2173. filter->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_filter_selected));
  2174. flow_checkbox_options = memnew(HFlowContainer);
  2175. flow_checkbox_options->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  2176. flow_checkbox_options->set_alignment(FlowContainer::ALIGNMENT_CENTER);
  2177. main_vbox->add_child(flow_checkbox_options);
  2178. grid_select_options = memnew(GridContainer);
  2179. grid_select_options->set_h_size_flags(Control::SIZE_SHRINK_CENTER);
  2180. grid_select_options->set_columns(2);
  2181. main_vbox->add_child(grid_select_options);
  2182. confirm_save = memnew(ConfirmationDialog);
  2183. add_child(confirm_save, false, INTERNAL_MODE_FRONT);
  2184. confirm_save->connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_save_confirm_pressed));
  2185. delete_dialog = memnew(ConfirmationDialog);
  2186. delete_dialog->set_text(ETR("Delete the selected file?\nDepending on your filesystem configuration, the files will either be moved to the system trash or deleted permanently."));
  2187. add_child(delete_dialog, false, INTERNAL_MODE_FRONT);
  2188. delete_dialog->connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_delete_confirm));
  2189. make_dir_dialog = memnew(ConfirmationDialog);
  2190. make_dir_dialog->set_title(ETR("Create Folder"));
  2191. add_child(make_dir_dialog, false, INTERNAL_MODE_FRONT);
  2192. make_dir_dialog->connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_make_dir_confirm));
  2193. VBoxContainer *makevb = memnew(VBoxContainer);
  2194. make_dir_dialog->add_child(makevb);
  2195. new_dir_name = memnew(LineEdit);
  2196. new_dir_name->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
  2197. makevb->add_margin_child(ETR("Name:"), new_dir_name);
  2198. make_dir_dialog->register_text_enter(new_dir_name);
  2199. mkdirerr = memnew(AcceptDialog);
  2200. mkdirerr->set_text(ETR("Could not create folder."));
  2201. add_child(mkdirerr, false, INTERNAL_MODE_FRONT);
  2202. exterr = memnew(AcceptDialog);
  2203. exterr->set_text(ETR("Invalid extension, or empty filename."));
  2204. add_child(exterr, false, INTERNAL_MODE_FRONT);
  2205. item_menu = memnew(PopupMenu);
  2206. item_menu->connect(SceneStringName(id_pressed), callable_mp(this, &FileDialog::_item_menu_id_pressed));
  2207. add_child(item_menu, false, INTERNAL_MODE_FRONT);
  2208. connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_action_pressed));
  2209. _update_drives();
  2210. update_filters();
  2211. update_filename_filter_gui();
  2212. update_dir();
  2213. if (register_func) {
  2214. register_func(this);
  2215. }
  2216. property_helper.setup_for_instance(base_property_helper, this);
  2217. }
  2218. FileDialog::~FileDialog() {
  2219. if (unregister_func) {
  2220. unregister_func(this);
  2221. }
  2222. }