editor_settings_dialog.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  1. /*************************************************************************/
  2. /* editor_settings_dialog.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "editor_settings_dialog.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/input/input_map.h"
  33. #include "core/os/keyboard.h"
  34. #include "editor/debugger/editor_debugger_node.h"
  35. #include "editor/editor_file_system.h"
  36. #include "editor/editor_log.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_property_name_processor.h"
  39. #include "editor/editor_scale.h"
  40. #include "editor/editor_settings.h"
  41. #include "editor/editor_undo_redo_manager.h"
  42. #include "scene/gui/margin_container.h"
  43. void EditorSettingsDialog::ok_pressed() {
  44. if (!EditorSettings::get_singleton()) {
  45. return;
  46. }
  47. _settings_save();
  48. timer->stop();
  49. }
  50. void EditorSettingsDialog::_settings_changed() {
  51. timer->start();
  52. }
  53. void EditorSettingsDialog::_settings_property_edited(const String &p_name) {
  54. String full_name = inspector->get_full_item_path(p_name);
  55. if (full_name == "interface/theme/accent_color" || full_name == "interface/theme/base_color" || full_name == "interface/theme/contrast") {
  56. EditorSettings::get_singleton()->set_manually("interface/theme/preset", "Custom"); // set preset to Custom
  57. } else if (full_name.begins_with("text_editor/theme/highlighting")) {
  58. EditorSettings::get_singleton()->set_manually("text_editor/theme/color_theme", "Custom");
  59. }
  60. }
  61. void EditorSettingsDialog::_settings_save() {
  62. EditorSettings::get_singleton()->notify_changes();
  63. EditorSettings::get_singleton()->save();
  64. }
  65. void EditorSettingsDialog::cancel_pressed() {
  66. if (!EditorSettings::get_singleton()) {
  67. return;
  68. }
  69. EditorSettings::get_singleton()->notify_changes();
  70. }
  71. void EditorSettingsDialog::popup_edit_settings() {
  72. if (!EditorSettings::get_singleton()) {
  73. return;
  74. }
  75. EditorSettings::get_singleton()->list_text_editor_themes(); // make sure we have an up to date list of themes
  76. inspector->edit(EditorSettings::get_singleton());
  77. inspector->get_inspector()->update_tree();
  78. search_box->select_all();
  79. search_box->grab_focus();
  80. _update_shortcuts();
  81. set_process_shortcut_input(true);
  82. // Restore valid window bounds or pop up at default size.
  83. Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "editor_settings", Rect2());
  84. if (saved_size != Rect2()) {
  85. popup(saved_size);
  86. } else {
  87. popup_centered_clamped(Size2(900, 700) * EDSCALE, 0.8);
  88. }
  89. _focus_current_search_box();
  90. }
  91. void EditorSettingsDialog::_filter_shortcuts(const String &p_filter) {
  92. shortcut_filter = p_filter;
  93. _update_shortcuts();
  94. }
  95. void EditorSettingsDialog::_undo_redo_callback(void *p_self, const String &p_name) {
  96. EditorNode::get_log()->add_message(p_name, EditorLog::MSG_TYPE_EDITOR);
  97. }
  98. void EditorSettingsDialog::_notification(int p_what) {
  99. switch (p_what) {
  100. case NOTIFICATION_VISIBILITY_CHANGED: {
  101. if (!is_visible()) {
  102. EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "editor_settings", Rect2(get_position(), get_size()));
  103. set_process_shortcut_input(false);
  104. }
  105. } break;
  106. case NOTIFICATION_READY: {
  107. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_method_notify_callback(EditorDebuggerNode::_method_changeds, nullptr);
  108. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_property_notify_callback(EditorDebuggerNode::_property_changeds, nullptr);
  109. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_commit_notify_callback(_undo_redo_callback, this);
  110. } break;
  111. case NOTIFICATION_ENTER_TREE: {
  112. _update_icons();
  113. } break;
  114. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  115. _update_icons();
  116. bool update_shortcuts_tab =
  117. EditorSettings::get_singleton()->check_changed_settings_in_group("shortcuts") ||
  118. EditorSettings::get_singleton()->check_changed_settings_in_group("builtin_action_overrides");
  119. if (update_shortcuts_tab) {
  120. _update_shortcuts();
  121. }
  122. inspector->update_category_list();
  123. } break;
  124. }
  125. }
  126. void EditorSettingsDialog::shortcut_input(const Ref<InputEvent> &p_event) {
  127. ERR_FAIL_COND(p_event.is_null());
  128. const Ref<InputEventKey> k = p_event;
  129. if (k.is_valid() && k->is_pressed()) {
  130. bool handled = false;
  131. if (ED_IS_SHORTCUT("ui_undo", p_event)) {
  132. String action = undo_redo->get_current_action_name();
  133. if (!action.is_empty()) {
  134. EditorNode::get_log()->add_message("Undo: " + action, EditorLog::MSG_TYPE_EDITOR);
  135. }
  136. undo_redo->undo();
  137. handled = true;
  138. }
  139. if (ED_IS_SHORTCUT("ui_redo", p_event)) {
  140. undo_redo->redo();
  141. String action = undo_redo->get_current_action_name();
  142. if (!action.is_empty()) {
  143. EditorNode::get_log()->add_message("Redo: " + action, EditorLog::MSG_TYPE_EDITOR);
  144. }
  145. handled = true;
  146. }
  147. if (k->get_keycode_with_modifiers() == (KeyModifierMask::CMD | Key::F)) {
  148. _focus_current_search_box();
  149. handled = true;
  150. }
  151. if (handled) {
  152. set_input_as_handled();
  153. }
  154. }
  155. }
  156. void EditorSettingsDialog::_update_icons() {
  157. search_box->set_right_icon(shortcuts->get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
  158. search_box->set_clear_button_enabled(true);
  159. shortcut_search_box->set_right_icon(shortcuts->get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
  160. shortcut_search_box->set_clear_button_enabled(true);
  161. restart_close_button->set_icon(shortcuts->get_theme_icon(SNAME("Close"), SNAME("EditorIcons")));
  162. restart_container->add_theme_style_override("panel", shortcuts->get_theme_stylebox(SNAME("bg"), SNAME("Tree")));
  163. restart_icon->set_texture(shortcuts->get_theme_icon(SNAME("StatusWarning"), SNAME("EditorIcons")));
  164. restart_label->add_theme_color_override("font_color", shortcuts->get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  165. }
  166. void EditorSettingsDialog::_event_config_confirmed() {
  167. Ref<InputEventKey> k = shortcut_editor->get_event();
  168. if (k.is_null()) {
  169. return;
  170. }
  171. if (current_event_index == -1) {
  172. // Add new event
  173. current_events.push_back(k);
  174. } else {
  175. // Edit existing event
  176. current_events[current_event_index] = k;
  177. }
  178. if (is_editing_action) {
  179. _update_builtin_action(current_edited_identifier, current_events);
  180. } else {
  181. _update_shortcut_events(current_edited_identifier, current_events);
  182. }
  183. }
  184. void EditorSettingsDialog::_update_builtin_action(const String &p_name, const Array &p_events) {
  185. Array old_input_array = EditorSettings::get_singleton()->get_builtin_action_overrides(p_name);
  186. undo_redo->create_action(TTR("Edit Built-in Action") + " '" + p_name + "'");
  187. undo_redo->add_do_method(EditorSettings::get_singleton(), "mark_setting_changed", "builtin_action_overrides");
  188. undo_redo->add_undo_method(EditorSettings::get_singleton(), "mark_setting_changed", "builtin_action_overrides");
  189. undo_redo->add_do_method(EditorSettings::get_singleton(), "set_builtin_action_override", p_name, p_events);
  190. undo_redo->add_undo_method(EditorSettings::get_singleton(), "set_builtin_action_override", p_name, old_input_array);
  191. undo_redo->add_do_method(this, "_settings_changed");
  192. undo_redo->add_undo_method(this, "_settings_changed");
  193. undo_redo->commit_action();
  194. _update_shortcuts();
  195. }
  196. void EditorSettingsDialog::_update_shortcut_events(const String &p_path, const Array &p_events) {
  197. Ref<Shortcut> current_sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  198. undo_redo->create_action(TTR("Edit Shortcut") + " '" + p_path + "'");
  199. undo_redo->add_do_method(current_sc.ptr(), "set_events", p_events);
  200. undo_redo->add_undo_method(current_sc.ptr(), "set_events", current_sc->get_events());
  201. undo_redo->add_do_method(EditorSettings::get_singleton(), "mark_setting_changed", "shortcuts");
  202. undo_redo->add_undo_method(EditorSettings::get_singleton(), "mark_setting_changed", "shortcuts");
  203. undo_redo->add_do_method(this, "_update_shortcuts");
  204. undo_redo->add_undo_method(this, "_update_shortcuts");
  205. undo_redo->add_do_method(this, "_settings_changed");
  206. undo_redo->add_undo_method(this, "_settings_changed");
  207. undo_redo->commit_action();
  208. }
  209. Array EditorSettingsDialog::_event_list_to_array_helper(const List<Ref<InputEvent>> &p_events) {
  210. Array events;
  211. // Convert the list to an array, and only keep key events as this is for the editor.
  212. for (const List<Ref<InputEvent>>::Element *E = p_events.front(); E; E = E->next()) {
  213. Ref<InputEventKey> k = E->get();
  214. if (k.is_valid()) {
  215. events.append(E->get());
  216. }
  217. }
  218. return events;
  219. }
  220. void EditorSettingsDialog::_create_shortcut_treeitem(TreeItem *p_parent, const String &p_shortcut_identifier, const String &p_display, Array &p_events, bool p_allow_revert, bool p_is_action, bool p_is_collapsed) {
  221. TreeItem *shortcut_item = shortcuts->create_item(p_parent);
  222. shortcut_item->set_collapsed(p_is_collapsed);
  223. shortcut_item->set_text(0, p_display);
  224. Ref<InputEvent> primary = p_events.size() > 0 ? Ref<InputEvent>(p_events[0]) : Ref<InputEvent>();
  225. Ref<InputEvent> secondary = p_events.size() > 1 ? Ref<InputEvent>(p_events[1]) : Ref<InputEvent>();
  226. String sc_text = "None";
  227. if (primary.is_valid()) {
  228. sc_text = primary->as_text();
  229. if (secondary.is_valid()) {
  230. sc_text += ", " + secondary->as_text();
  231. if (p_events.size() > 2) {
  232. sc_text += " (+" + itos(p_events.size() - 2) + ")";
  233. }
  234. }
  235. }
  236. shortcut_item->set_text(1, sc_text);
  237. if (sc_text == "None") {
  238. // Fade out unassigned shortcut labels for easier visual grepping.
  239. shortcut_item->set_custom_color(1, shortcuts->get_theme_color(SNAME("font_color"), SNAME("Label")) * Color(1, 1, 1, 0.5));
  240. }
  241. if (p_allow_revert) {
  242. shortcut_item->add_button(1, shortcuts->get_theme_icon(SNAME("Reload"), SNAME("EditorIcons")), SHORTCUT_REVERT);
  243. }
  244. shortcut_item->add_button(1, shortcuts->get_theme_icon(SNAME("Add"), SNAME("EditorIcons")), SHORTCUT_ADD);
  245. shortcut_item->add_button(1, shortcuts->get_theme_icon(SNAME("Close"), SNAME("EditorIcons")), SHORTCUT_ERASE);
  246. shortcut_item->set_meta("is_action", p_is_action);
  247. shortcut_item->set_meta("type", "shortcut");
  248. shortcut_item->set_meta("shortcut_identifier", p_shortcut_identifier);
  249. shortcut_item->set_meta("events", p_events);
  250. // Shortcut Input Events
  251. for (int i = 0; i < p_events.size(); i++) {
  252. Ref<InputEvent> ie = p_events[i];
  253. if (ie.is_null()) {
  254. continue;
  255. }
  256. TreeItem *event_item = shortcuts->create_item(shortcut_item);
  257. event_item->set_text(0, shortcut_item->get_child_count() == 1 ? "Primary" : "");
  258. event_item->set_text(1, ie->as_text());
  259. event_item->add_button(1, shortcuts->get_theme_icon(SNAME("Edit"), SNAME("EditorIcons")), SHORTCUT_EDIT);
  260. event_item->add_button(1, shortcuts->get_theme_icon(SNAME("Close"), SNAME("EditorIcons")), SHORTCUT_ERASE);
  261. event_item->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("dark_color_3"), SNAME("Editor")));
  262. event_item->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("dark_color_3"), SNAME("Editor")));
  263. event_item->set_meta("is_action", p_is_action);
  264. event_item->set_meta("type", "event");
  265. event_item->set_meta("event_index", i);
  266. }
  267. }
  268. void EditorSettingsDialog::_update_shortcuts() {
  269. // Before clearing the tree, take note of which categories are collapsed so that this state can be maintained when the tree is repopulated.
  270. HashMap<String, bool> collapsed;
  271. if (shortcuts->get_root() && shortcuts->get_root()->get_first_child()) {
  272. TreeItem *ti = shortcuts->get_root()->get_first_child();
  273. while (ti) {
  274. // Not all items have valid or unique text in the first column - so if it has an identifier, use that, as it should be unique.
  275. if (ti->get_first_child() && ti->has_meta("shortcut_identifier")) {
  276. collapsed[ti->get_meta("shortcut_identifier")] = ti->is_collapsed();
  277. } else {
  278. collapsed[ti->get_text(0)] = ti->is_collapsed();
  279. }
  280. // Try go down tree
  281. TreeItem *ti_next = ti->get_first_child();
  282. // Try go to the next node via in-order traversal
  283. if (!ti_next) {
  284. ti_next = ti;
  285. while (ti_next && !ti_next->get_next()) {
  286. ti_next = ti_next->get_parent();
  287. }
  288. if (ti_next) {
  289. ti_next = ti_next->get_next();
  290. }
  291. }
  292. ti = ti_next;
  293. }
  294. }
  295. shortcuts->clear();
  296. TreeItem *root = shortcuts->create_item();
  297. HashMap<String, TreeItem *> sections;
  298. // Set up section for Common/Built-in actions
  299. TreeItem *common_section = shortcuts->create_item(root);
  300. sections["Common"] = common_section;
  301. common_section->set_text(0, TTR("Common"));
  302. common_section->set_selectable(0, false);
  303. common_section->set_selectable(1, false);
  304. if (collapsed.has("Common")) {
  305. common_section->set_collapsed(collapsed["Common"]);
  306. }
  307. common_section->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("prop_subsection"), SNAME("Editor")));
  308. common_section->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("prop_subsection"), SNAME("Editor")));
  309. // Get the action map for the editor, and add each item to the "Common" section.
  310. for (const KeyValue<StringName, InputMap::Action> &E : InputMap::get_singleton()->get_action_map()) {
  311. const String &action_name = E.key;
  312. const InputMap::Action &action = E.value;
  313. Array events; // Need to get the list of events into an array so it can be set as metadata on the item.
  314. Vector<String> event_strings;
  315. // Skip non-builtin actions.
  316. if (!InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().has(action_name)) {
  317. continue;
  318. }
  319. const List<Ref<InputEvent>> &all_default_events = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(action_name)->value;
  320. List<Ref<InputEventKey>> key_default_events;
  321. // Remove all non-key events from the defaults. Only check keys, since we are in the editor.
  322. for (const List<Ref<InputEvent>>::Element *I = all_default_events.front(); I; I = I->next()) {
  323. Ref<InputEventKey> k = I->get();
  324. if (k.is_valid()) {
  325. key_default_events.push_back(k);
  326. }
  327. }
  328. // Join the text of the events with a delimiter so they can all be displayed in one cell.
  329. String events_display_string = event_strings.is_empty() ? "None" : String("; ").join(event_strings);
  330. if (!shortcut_filter.is_subsequence_ofn(action_name) && (events_display_string == "None" || !shortcut_filter.is_subsequence_ofn(events_display_string))) {
  331. continue;
  332. }
  333. Array action_events = _event_list_to_array_helper(action.inputs);
  334. Array default_events = _event_list_to_array_helper(all_default_events);
  335. bool same_as_defaults = Shortcut::is_event_array_equal(default_events, action_events);
  336. bool collapse = !collapsed.has(action_name) || (collapsed.has(action_name) && collapsed[action_name]);
  337. _create_shortcut_treeitem(common_section, action_name, action_name, action_events, !same_as_defaults, true, collapse);
  338. }
  339. // Editor Shortcuts
  340. List<String> slist;
  341. EditorSettings::get_singleton()->get_shortcut_list(&slist);
  342. const EditorPropertyNameProcessor::Style name_style = EditorPropertyNameProcessor::get_settings_style();
  343. const EditorPropertyNameProcessor::Style tooltip_style = EditorPropertyNameProcessor::get_tooltip_style(name_style);
  344. for (const String &E : slist) {
  345. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(E);
  346. if (!sc->has_meta("original")) {
  347. continue;
  348. }
  349. // Shortcut Section
  350. TreeItem *section;
  351. String section_name = E.get_slice("/", 0);
  352. if (sections.has(section_name)) {
  353. section = sections[section_name];
  354. } else {
  355. section = shortcuts->create_item(root);
  356. const String item_name = EditorPropertyNameProcessor::get_singleton()->process_name(section_name, name_style);
  357. const String tooltip = EditorPropertyNameProcessor::get_singleton()->process_name(section_name, tooltip_style);
  358. section->set_text(0, item_name);
  359. section->set_tooltip_text(0, tooltip);
  360. section->set_selectable(0, false);
  361. section->set_selectable(1, false);
  362. section->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("prop_subsection"), SNAME("Editor")));
  363. section->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("prop_subsection"), SNAME("Editor")));
  364. if (collapsed.has(item_name)) {
  365. section->set_collapsed(collapsed[item_name]);
  366. }
  367. sections[section_name] = section;
  368. }
  369. // Shortcut Item
  370. if (!shortcut_filter.is_subsequence_ofn(sc->get_name())) {
  371. continue;
  372. }
  373. Array original = sc->get_meta("original");
  374. Array shortcuts_array = sc->get_events().duplicate(true);
  375. bool same_as_defaults = Shortcut::is_event_array_equal(original, shortcuts_array);
  376. bool collapse = !collapsed.has(E) || (collapsed.has(E) && collapsed[E]);
  377. _create_shortcut_treeitem(section, E, sc->get_name(), shortcuts_array, !same_as_defaults, false, collapse);
  378. }
  379. // remove sections with no shortcuts
  380. for (KeyValue<String, TreeItem *> &E : sections) {
  381. TreeItem *section = E.value;
  382. if (section->get_first_child() == nullptr) {
  383. root->remove_child(section);
  384. }
  385. }
  386. }
  387. void EditorSettingsDialog::_shortcut_button_pressed(Object *p_item, int p_column, int p_idx, MouseButton p_button) {
  388. if (p_button != MouseButton::LEFT) {
  389. return;
  390. }
  391. TreeItem *ti = Object::cast_to<TreeItem>(p_item);
  392. ERR_FAIL_COND_MSG(!ti, "Object passed is not a TreeItem");
  393. ShortcutButton button_idx = (ShortcutButton)p_idx;
  394. is_editing_action = ti->get_meta("is_action");
  395. String type = ti->get_meta("type");
  396. if (type == "event") {
  397. current_edited_identifier = ti->get_parent()->get_meta("shortcut_identifier");
  398. current_events = ti->get_parent()->get_meta("events");
  399. current_event_index = ti->get_meta("event_index");
  400. } else { // Type is "shortcut"
  401. current_edited_identifier = ti->get_meta("shortcut_identifier");
  402. current_events = ti->get_meta("events");
  403. current_event_index = -1;
  404. }
  405. switch (button_idx) {
  406. case EditorSettingsDialog::SHORTCUT_ADD: {
  407. // Only for "shortcut" types
  408. shortcut_editor->popup_and_configure();
  409. } break;
  410. case EditorSettingsDialog::SHORTCUT_EDIT: {
  411. // Only for "event" types
  412. shortcut_editor->popup_and_configure(current_events[current_event_index]);
  413. } break;
  414. case EditorSettingsDialog::SHORTCUT_ERASE: {
  415. if (type == "shortcut") {
  416. if (is_editing_action) {
  417. _update_builtin_action(current_edited_identifier, Array());
  418. } else {
  419. _update_shortcut_events(current_edited_identifier, Array());
  420. }
  421. } else if (type == "event") {
  422. current_events.remove_at(current_event_index);
  423. if (is_editing_action) {
  424. _update_builtin_action(current_edited_identifier, current_events);
  425. } else {
  426. _update_shortcut_events(current_edited_identifier, current_events);
  427. }
  428. }
  429. } break;
  430. case EditorSettingsDialog::SHORTCUT_REVERT: {
  431. // Only for "shortcut" types
  432. if (is_editing_action) {
  433. List<Ref<InputEvent>> defaults = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied()[current_edited_identifier];
  434. Array events = _event_list_to_array_helper(defaults);
  435. _update_builtin_action(current_edited_identifier, events);
  436. } else {
  437. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(current_edited_identifier);
  438. Array original = sc->get_meta("original");
  439. _update_shortcut_events(current_edited_identifier, original);
  440. }
  441. } break;
  442. default:
  443. break;
  444. }
  445. }
  446. void EditorSettingsDialog::_shortcut_cell_double_clicked() {
  447. // When a shortcut cell is double clicked:
  448. // If the cell has children and is in the bindings column, and if its first child is editable,
  449. // then uncollapse the cell, and if the first child is the only child, then edit that child.
  450. // If the cell is in the bindings column and can be edited, then edit it.
  451. // If the cell is in the name column, then toggle collapse.
  452. const ShortcutButton edit_btn_id = EditorSettingsDialog::SHORTCUT_EDIT;
  453. const int edit_btn_col = 1;
  454. TreeItem *ti = shortcuts->get_selected();
  455. String type = ti->get_meta("type");
  456. int col = shortcuts->get_selected_column();
  457. if (type == "shortcut" && col == 0) {
  458. if (ti->get_first_child()) {
  459. ti->set_collapsed(!ti->is_collapsed());
  460. }
  461. } else if (type == "shortcut" && col == 1) {
  462. if (ti->get_first_child()) {
  463. TreeItem *child_ti = ti->get_first_child();
  464. if (child_ti->get_button_by_id(edit_btn_col, edit_btn_id) != -1) {
  465. ti->set_collapsed(false);
  466. if (ti->get_child_count() == 1) {
  467. _shortcut_button_pressed(child_ti, edit_btn_col, edit_btn_id);
  468. }
  469. }
  470. }
  471. } else if (type == "event" && col == 1) {
  472. if (ti->get_button_by_id(edit_btn_col, edit_btn_id) != -1) {
  473. _shortcut_button_pressed(ti, edit_btn_col, edit_btn_id);
  474. }
  475. }
  476. }
  477. Variant EditorSettingsDialog::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  478. TreeItem *selected = shortcuts->get_selected();
  479. // Only allow drag for events
  480. if (!selected || (String)selected->get_meta("type", "") != "event") {
  481. return Variant();
  482. }
  483. String label_text = "Event " + itos(selected->get_meta("event_index"));
  484. Label *label = memnew(Label(label_text));
  485. label->set_modulate(Color(1, 1, 1, 1.0f));
  486. shortcuts->set_drag_preview(label);
  487. shortcuts->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
  488. return Dictionary(); // No data required
  489. }
  490. bool EditorSettingsDialog::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  491. TreeItem *selected = shortcuts->get_selected();
  492. TreeItem *item = shortcuts->get_item_at_position(p_point);
  493. if (!selected || !item || item == selected || (String)item->get_meta("type", "") != "event") {
  494. return false;
  495. }
  496. // Don't allow moving an events in-between shortcuts.
  497. if (selected->get_parent()->get_meta("shortcut_identifier") != item->get_parent()->get_meta("shortcut_identifier")) {
  498. return false;
  499. }
  500. return true;
  501. }
  502. void EditorSettingsDialog::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  503. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  504. return;
  505. }
  506. TreeItem *selected = shortcuts->get_selected();
  507. TreeItem *target = shortcuts->get_item_at_position(p_point);
  508. if (!target) {
  509. return;
  510. }
  511. int target_event_index = target->get_meta("event_index");
  512. int index_moving_from = selected->get_meta("event_index");
  513. Array events = selected->get_parent()->get_meta("events");
  514. Variant event_moved = events[index_moving_from];
  515. events.remove_at(index_moving_from);
  516. events.insert(target_event_index, event_moved);
  517. String ident = selected->get_parent()->get_meta("shortcut_identifier");
  518. if (selected->get_meta("is_action")) {
  519. _update_builtin_action(ident, events);
  520. } else {
  521. _update_shortcut_events(ident, events);
  522. }
  523. }
  524. void EditorSettingsDialog::_tabs_tab_changed(int p_tab) {
  525. _focus_current_search_box();
  526. }
  527. void EditorSettingsDialog::_focus_current_search_box() {
  528. Control *tab = tabs->get_current_tab_control();
  529. LineEdit *current_search_box = nullptr;
  530. if (tab == tab_general) {
  531. current_search_box = search_box;
  532. } else if (tab == tab_shortcuts) {
  533. current_search_box = shortcut_search_box;
  534. }
  535. if (current_search_box) {
  536. current_search_box->grab_focus();
  537. current_search_box->select_all();
  538. }
  539. }
  540. void EditorSettingsDialog::_editor_restart() {
  541. EditorNode::get_singleton()->save_all_scenes();
  542. EditorNode::get_singleton()->restart_editor();
  543. }
  544. void EditorSettingsDialog::_editor_restart_request() {
  545. restart_container->show();
  546. }
  547. void EditorSettingsDialog::_editor_restart_close() {
  548. restart_container->hide();
  549. }
  550. void EditorSettingsDialog::_bind_methods() {
  551. ClassDB::bind_method(D_METHOD("_update_shortcuts"), &EditorSettingsDialog::_update_shortcuts);
  552. ClassDB::bind_method(D_METHOD("_settings_changed"), &EditorSettingsDialog::_settings_changed);
  553. ClassDB::bind_method(D_METHOD("_get_drag_data_fw"), &EditorSettingsDialog::get_drag_data_fw);
  554. ClassDB::bind_method(D_METHOD("_can_drop_data_fw"), &EditorSettingsDialog::can_drop_data_fw);
  555. ClassDB::bind_method(D_METHOD("_drop_data_fw"), &EditorSettingsDialog::drop_data_fw);
  556. }
  557. EditorSettingsDialog::EditorSettingsDialog() {
  558. set_title(TTR("Editor Settings"));
  559. undo_redo = EditorNode::get_undo_redo();
  560. tabs = memnew(TabContainer);
  561. tabs->set_theme_type_variation("TabContainerOdd");
  562. tabs->connect("tab_changed", callable_mp(this, &EditorSettingsDialog::_tabs_tab_changed));
  563. add_child(tabs);
  564. // General Tab
  565. tab_general = memnew(VBoxContainer);
  566. tabs->add_child(tab_general);
  567. tab_general->set_name(TTR("General"));
  568. HBoxContainer *hbc = memnew(HBoxContainer);
  569. hbc->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  570. tab_general->add_child(hbc);
  571. search_box = memnew(LineEdit);
  572. search_box->set_placeholder(TTR("Filter Settings"));
  573. search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  574. hbc->add_child(search_box);
  575. inspector = memnew(SectionedInspector);
  576. inspector->get_inspector()->set_use_filter(true);
  577. inspector->register_search_box(search_box);
  578. inspector->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  579. inspector->get_inspector()->set_undo_redo(undo_redo);
  580. tab_general->add_child(inspector);
  581. inspector->get_inspector()->connect("property_edited", callable_mp(this, &EditorSettingsDialog::_settings_property_edited));
  582. inspector->get_inspector()->connect("restart_requested", callable_mp(this, &EditorSettingsDialog::_editor_restart_request));
  583. restart_container = memnew(PanelContainer);
  584. tab_general->add_child(restart_container);
  585. HBoxContainer *restart_hb = memnew(HBoxContainer);
  586. restart_container->add_child(restart_hb);
  587. restart_icon = memnew(TextureRect);
  588. restart_icon->set_v_size_flags(Control::SIZE_SHRINK_CENTER);
  589. restart_hb->add_child(restart_icon);
  590. restart_label = memnew(Label);
  591. restart_label->set_text(TTR("The editor must be restarted for changes to take effect."));
  592. restart_hb->add_child(restart_label);
  593. restart_hb->add_spacer();
  594. Button *restart_button = memnew(Button);
  595. restart_button->connect("pressed", callable_mp(this, &EditorSettingsDialog::_editor_restart));
  596. restart_hb->add_child(restart_button);
  597. restart_button->set_text(TTR("Save & Restart"));
  598. restart_close_button = memnew(Button);
  599. restart_close_button->set_flat(true);
  600. restart_close_button->connect("pressed", callable_mp(this, &EditorSettingsDialog::_editor_restart_close));
  601. restart_hb->add_child(restart_close_button);
  602. restart_container->hide();
  603. // Shortcuts Tab
  604. tab_shortcuts = memnew(VBoxContainer);
  605. tabs->add_child(tab_shortcuts);
  606. tab_shortcuts->set_name(TTR("Shortcuts"));
  607. shortcut_search_box = memnew(LineEdit);
  608. shortcut_search_box->set_placeholder(TTR("Filter Shortcuts"));
  609. shortcut_search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  610. tab_shortcuts->add_child(shortcut_search_box);
  611. shortcut_search_box->connect("text_changed", callable_mp(this, &EditorSettingsDialog::_filter_shortcuts));
  612. shortcuts = memnew(Tree);
  613. shortcuts->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  614. shortcuts->set_columns(2);
  615. shortcuts->set_hide_root(true);
  616. shortcuts->set_column_titles_visible(true);
  617. shortcuts->set_column_title(0, TTR("Name"));
  618. shortcuts->set_column_title(1, TTR("Binding"));
  619. shortcuts->connect("button_clicked", callable_mp(this, &EditorSettingsDialog::_shortcut_button_pressed));
  620. shortcuts->connect("item_activated", callable_mp(this, &EditorSettingsDialog::_shortcut_cell_double_clicked));
  621. tab_shortcuts->add_child(shortcuts);
  622. shortcuts->set_drag_forwarding(this);
  623. // Adding event dialog
  624. shortcut_editor = memnew(InputEventConfigurationDialog);
  625. shortcut_editor->connect("confirmed", callable_mp(this, &EditorSettingsDialog::_event_config_confirmed));
  626. shortcut_editor->set_allowed_input_types(InputEventConfigurationDialog::InputType::INPUT_KEY);
  627. add_child(shortcut_editor);
  628. set_hide_on_ok(true);
  629. timer = memnew(Timer);
  630. timer->set_wait_time(1.5);
  631. timer->connect("timeout", callable_mp(this, &EditorSettingsDialog::_settings_save));
  632. timer->set_one_shot(true);
  633. add_child(timer);
  634. EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &EditorSettingsDialog::_settings_changed));
  635. set_ok_button_text(TTR("Close"));
  636. }
  637. EditorSettingsDialog::~EditorSettingsDialog() {
  638. }