editor_settings_dialog.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824
  1. /**************************************************************************/
  2. /* editor_settings_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 "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_settings.h"
  40. #include "editor/editor_string_names.h"
  41. #include "editor/editor_undo_redo_manager.h"
  42. #include "editor/event_listener_line_edit.h"
  43. #include "editor/input_event_configuration_dialog.h"
  44. #include "editor/themes/editor_scale.h"
  45. #include "editor/themes/editor_theme_manager.h"
  46. #include "scene/gui/margin_container.h"
  47. void EditorSettingsDialog::ok_pressed() {
  48. if (!EditorSettings::get_singleton()) {
  49. return;
  50. }
  51. _settings_save();
  52. timer->stop();
  53. }
  54. void EditorSettingsDialog::_settings_changed() {
  55. timer->start();
  56. }
  57. void EditorSettingsDialog::_settings_property_edited(const String &p_name) {
  58. String full_name = inspector->get_full_item_path(p_name);
  59. // Set theme presets to Custom when controlled settings change.
  60. if (full_name == "interface/theme/accent_color" || full_name == "interface/theme/base_color" || full_name == "interface/theme/contrast" || full_name == "interface/theme/draw_extra_borders") {
  61. EditorSettings::get_singleton()->set_manually("interface/theme/preset", "Custom");
  62. } else if (full_name == "interface/theme/base_spacing" || full_name == "interface/theme/additional_spacing") {
  63. EditorSettings::get_singleton()->set_manually("interface/theme/spacing_preset", "Custom");
  64. } else if (full_name.begins_with("text_editor/theme/highlighting")) {
  65. EditorSettings::get_singleton()->set_manually("text_editor/theme/color_theme", "Custom");
  66. } else if (full_name.begins_with("editors/visual_editors/connection_colors") || full_name.begins_with("editors/visual_editors/category_colors")) {
  67. EditorSettings::get_singleton()->set_manually("editors/visual_editors/color_theme", "Custom");
  68. }
  69. }
  70. void EditorSettingsDialog::_settings_save() {
  71. EditorSettings::get_singleton()->notify_changes();
  72. EditorSettings::get_singleton()->save();
  73. }
  74. void EditorSettingsDialog::cancel_pressed() {
  75. if (!EditorSettings::get_singleton()) {
  76. return;
  77. }
  78. EditorSettings::get_singleton()->notify_changes();
  79. }
  80. void EditorSettingsDialog::popup_edit_settings() {
  81. if (!EditorSettings::get_singleton()) {
  82. return;
  83. }
  84. EditorSettings::get_singleton()->list_text_editor_themes(); // make sure we have an up to date list of themes
  85. inspector->edit(EditorSettings::get_singleton());
  86. inspector->get_inspector()->update_tree();
  87. _update_shortcuts();
  88. set_process_shortcut_input(true);
  89. // Restore valid window bounds or pop up at default size.
  90. Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "editor_settings", Rect2());
  91. if (saved_size != Rect2()) {
  92. popup(saved_size);
  93. } else {
  94. popup_centered_clamped(Size2(900, 700) * EDSCALE, 0.8);
  95. }
  96. _focus_current_search_box();
  97. }
  98. void EditorSettingsDialog::_filter_shortcuts(const String &) {
  99. _update_shortcuts();
  100. }
  101. void EditorSettingsDialog::_filter_shortcuts_by_event(const Ref<InputEvent> &p_event) {
  102. if (p_event.is_null() || (p_event->is_pressed() && !p_event->is_echo())) {
  103. _update_shortcuts();
  104. }
  105. }
  106. void EditorSettingsDialog::_undo_redo_callback(void *p_self, const String &p_name) {
  107. EditorNode::get_log()->add_message(p_name, EditorLog::MSG_TYPE_EDITOR);
  108. }
  109. void EditorSettingsDialog::_notification(int p_what) {
  110. switch (p_what) {
  111. case NOTIFICATION_VISIBILITY_CHANGED: {
  112. if (!is_visible()) {
  113. EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "editor_settings", Rect2(get_position(), get_size()));
  114. set_process_shortcut_input(false);
  115. }
  116. } break;
  117. case NOTIFICATION_READY: {
  118. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  119. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_method_notify_callback(EditorDebuggerNode::_method_changeds, nullptr);
  120. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_property_notify_callback(EditorDebuggerNode::_property_changeds, nullptr);
  121. undo_redo->get_or_create_history(EditorUndoRedoManager::GLOBAL_HISTORY).undo_redo->set_commit_notify_callback(_undo_redo_callback, this);
  122. } break;
  123. case NOTIFICATION_ENTER_TREE: {
  124. _update_icons();
  125. } break;
  126. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  127. if (EditorThemeManager::is_generated_theme_outdated()) {
  128. _update_icons();
  129. }
  130. bool update_shortcuts_tab =
  131. EditorSettings::get_singleton()->check_changed_settings_in_group("shortcuts") ||
  132. EditorSettings::get_singleton()->check_changed_settings_in_group("builtin_action_overrides");
  133. if (update_shortcuts_tab) {
  134. _update_shortcuts();
  135. }
  136. if (EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editor/localize_settings")) {
  137. inspector->update_category_list();
  138. }
  139. } break;
  140. }
  141. }
  142. void EditorSettingsDialog::shortcut_input(const Ref<InputEvent> &p_event) {
  143. ERR_FAIL_COND(p_event.is_null());
  144. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  145. const Ref<InputEventKey> k = p_event;
  146. if (k.is_valid() && k->is_pressed()) {
  147. bool handled = false;
  148. if (ED_IS_SHORTCUT("ui_undo", p_event)) {
  149. String action = undo_redo->get_current_action_name();
  150. if (!action.is_empty()) {
  151. EditorNode::get_log()->add_message(vformat(TTR("Undo: %s"), action), EditorLog::MSG_TYPE_EDITOR);
  152. }
  153. undo_redo->undo();
  154. handled = true;
  155. }
  156. if (ED_IS_SHORTCUT("ui_redo", p_event)) {
  157. undo_redo->redo();
  158. String action = undo_redo->get_current_action_name();
  159. if (!action.is_empty()) {
  160. EditorNode::get_log()->add_message(vformat(TTR("Redo: %s"), action), EditorLog::MSG_TYPE_EDITOR);
  161. }
  162. handled = true;
  163. }
  164. if (k->is_match(InputEventKey::create_reference(KeyModifierMask::CMD_OR_CTRL | Key::F))) {
  165. _focus_current_search_box();
  166. handled = true;
  167. }
  168. if (handled) {
  169. set_input_as_handled();
  170. }
  171. }
  172. }
  173. void EditorSettingsDialog::_update_icons() {
  174. search_box->set_right_icon(shortcuts->get_editor_theme_icon(SNAME("Search")));
  175. search_box->set_clear_button_enabled(true);
  176. shortcut_search_box->set_right_icon(shortcuts->get_editor_theme_icon(SNAME("Search")));
  177. shortcut_search_box->set_clear_button_enabled(true);
  178. restart_close_button->set_icon(shortcuts->get_editor_theme_icon(SNAME("Close")));
  179. restart_container->add_theme_style_override("panel", shortcuts->get_theme_stylebox(SNAME("panel"), SNAME("Tree")));
  180. restart_icon->set_texture(shortcuts->get_editor_theme_icon(SNAME("StatusWarning")));
  181. restart_label->add_theme_color_override("font_color", shortcuts->get_theme_color(SNAME("warning_color"), EditorStringName(Editor)));
  182. }
  183. void EditorSettingsDialog::_event_config_confirmed() {
  184. Ref<InputEventKey> k = shortcut_editor->get_event();
  185. if (k.is_null()) {
  186. return;
  187. }
  188. if (current_event_index == -1) {
  189. // Add new event
  190. current_events.push_back(k);
  191. } else {
  192. // Edit existing event
  193. current_events[current_event_index] = k;
  194. }
  195. if (is_editing_action) {
  196. _update_builtin_action(current_edited_identifier, current_events);
  197. } else {
  198. _update_shortcut_events(current_edited_identifier, current_events);
  199. }
  200. }
  201. void EditorSettingsDialog::_update_builtin_action(const String &p_name, const Array &p_events) {
  202. Array old_input_array = EditorSettings::get_singleton()->get_builtin_action_overrides(p_name);
  203. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  204. undo_redo->create_action(vformat(TTR("Edit Built-in Action: %s"), p_name));
  205. undo_redo->add_do_method(EditorSettings::get_singleton(), "mark_setting_changed", "builtin_action_overrides");
  206. undo_redo->add_undo_method(EditorSettings::get_singleton(), "mark_setting_changed", "builtin_action_overrides");
  207. undo_redo->add_do_method(EditorSettings::get_singleton(), "set_builtin_action_override", p_name, p_events);
  208. undo_redo->add_undo_method(EditorSettings::get_singleton(), "set_builtin_action_override", p_name, old_input_array);
  209. undo_redo->add_do_method(this, "_settings_changed");
  210. undo_redo->add_undo_method(this, "_settings_changed");
  211. undo_redo->commit_action();
  212. _update_shortcuts();
  213. }
  214. void EditorSettingsDialog::_update_shortcut_events(const String &p_path, const Array &p_events) {
  215. Ref<Shortcut> current_sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  216. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  217. undo_redo->create_action(vformat(TTR("Edit Shortcut: %s"), p_path));
  218. undo_redo->add_do_method(current_sc.ptr(), "set_events", p_events);
  219. undo_redo->add_undo_method(current_sc.ptr(), "set_events", current_sc->get_events());
  220. undo_redo->add_do_method(EditorSettings::get_singleton(), "mark_setting_changed", "shortcuts");
  221. undo_redo->add_undo_method(EditorSettings::get_singleton(), "mark_setting_changed", "shortcuts");
  222. undo_redo->add_do_method(this, "_update_shortcuts");
  223. undo_redo->add_undo_method(this, "_update_shortcuts");
  224. undo_redo->add_do_method(this, "_settings_changed");
  225. undo_redo->add_undo_method(this, "_settings_changed");
  226. undo_redo->commit_action();
  227. }
  228. Array EditorSettingsDialog::_event_list_to_array_helper(const List<Ref<InputEvent>> &p_events) {
  229. Array events;
  230. // Convert the list to an array, and only keep key events as this is for the editor.
  231. for (const List<Ref<InputEvent>>::Element *E = p_events.front(); E; E = E->next()) {
  232. Ref<InputEventKey> k = E->get();
  233. if (k.is_valid()) {
  234. events.append(E->get());
  235. }
  236. }
  237. return events;
  238. }
  239. 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) {
  240. TreeItem *shortcut_item = shortcuts->create_item(p_parent);
  241. shortcut_item->set_collapsed(p_is_collapsed);
  242. shortcut_item->set_text(0, p_display);
  243. Ref<InputEvent> primary = p_events.size() > 0 ? Ref<InputEvent>(p_events[0]) : Ref<InputEvent>();
  244. Ref<InputEvent> secondary = p_events.size() > 1 ? Ref<InputEvent>(p_events[1]) : Ref<InputEvent>();
  245. String sc_text = "None";
  246. if (primary.is_valid()) {
  247. sc_text = primary->as_text();
  248. if (secondary.is_valid()) {
  249. sc_text += ", " + secondary->as_text();
  250. if (p_events.size() > 2) {
  251. sc_text += " (+" + itos(p_events.size() - 2) + ")";
  252. }
  253. }
  254. }
  255. shortcut_item->set_text(1, sc_text);
  256. if (sc_text == "None") {
  257. // Fade out unassigned shortcut labels for easier visual grepping.
  258. shortcut_item->set_custom_color(1, shortcuts->get_theme_color(SNAME("font_color"), SNAME("Label")) * Color(1, 1, 1, 0.5));
  259. }
  260. if (p_allow_revert) {
  261. shortcut_item->add_button(1, shortcuts->get_editor_theme_icon(SNAME("Reload")), SHORTCUT_REVERT);
  262. }
  263. shortcut_item->add_button(1, shortcuts->get_editor_theme_icon(SNAME("Add")), SHORTCUT_ADD);
  264. shortcut_item->add_button(1, shortcuts->get_editor_theme_icon(SNAME("Close")), SHORTCUT_ERASE);
  265. shortcut_item->set_meta("is_action", p_is_action);
  266. shortcut_item->set_meta("type", "shortcut");
  267. shortcut_item->set_meta("shortcut_identifier", p_shortcut_identifier);
  268. shortcut_item->set_meta("events", p_events);
  269. // Shortcut Input Events
  270. for (int i = 0; i < p_events.size(); i++) {
  271. Ref<InputEvent> ie = p_events[i];
  272. if (ie.is_null()) {
  273. continue;
  274. }
  275. TreeItem *event_item = shortcuts->create_item(shortcut_item);
  276. event_item->set_text(0, shortcut_item->get_child_count() == 1 ? "Primary" : "");
  277. event_item->set_text(1, ie->as_text());
  278. event_item->add_button(1, shortcuts->get_editor_theme_icon(SNAME("Edit")), SHORTCUT_EDIT);
  279. event_item->add_button(1, shortcuts->get_editor_theme_icon(SNAME("Close")), SHORTCUT_ERASE);
  280. event_item->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("dark_color_3"), EditorStringName(Editor)));
  281. event_item->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("dark_color_3"), EditorStringName(Editor)));
  282. event_item->set_meta("is_action", p_is_action);
  283. event_item->set_meta("type", "event");
  284. event_item->set_meta("event_index", i);
  285. }
  286. }
  287. bool EditorSettingsDialog::_should_display_shortcut(const String &p_name, const Array &p_events) const {
  288. const Ref<InputEvent> search_ev = shortcut_search_by_event->get_event();
  289. bool event_match = true;
  290. if (search_ev.is_valid()) {
  291. event_match = false;
  292. for (int i = 0; i < p_events.size(); ++i) {
  293. const Ref<InputEvent> ev = p_events[i];
  294. if (ev.is_valid() && ev->is_match(search_ev, true)) {
  295. event_match = true;
  296. }
  297. }
  298. }
  299. return event_match && shortcut_search_box->get_text().is_subsequence_ofn(p_name);
  300. }
  301. void EditorSettingsDialog::_update_shortcuts() {
  302. // Before clearing the tree, take note of which categories are collapsed so that this state can be maintained when the tree is repopulated.
  303. HashMap<String, bool> collapsed;
  304. if (shortcuts->get_root() && shortcuts->get_root()->get_first_child()) {
  305. TreeItem *ti = shortcuts->get_root()->get_first_child();
  306. while (ti) {
  307. // 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.
  308. if (ti->get_first_child() && ti->has_meta("shortcut_identifier")) {
  309. collapsed[ti->get_meta("shortcut_identifier")] = ti->is_collapsed();
  310. } else {
  311. collapsed[ti->get_text(0)] = ti->is_collapsed();
  312. }
  313. // Try go down tree
  314. TreeItem *ti_next = ti->get_first_child();
  315. // Try go to the next node via in-order traversal
  316. if (!ti_next) {
  317. ti_next = ti;
  318. while (ti_next && !ti_next->get_next()) {
  319. ti_next = ti_next->get_parent();
  320. }
  321. if (ti_next) {
  322. ti_next = ti_next->get_next();
  323. }
  324. }
  325. ti = ti_next;
  326. }
  327. }
  328. shortcuts->clear();
  329. TreeItem *root = shortcuts->create_item();
  330. HashMap<String, TreeItem *> sections;
  331. // Set up section for Common/Built-in actions
  332. TreeItem *common_section = shortcuts->create_item(root);
  333. sections["Common"] = common_section;
  334. common_section->set_text(0, TTR("Common"));
  335. common_section->set_selectable(0, false);
  336. common_section->set_selectable(1, false);
  337. if (collapsed.has("Common")) {
  338. common_section->set_collapsed(collapsed["Common"]);
  339. }
  340. common_section->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  341. common_section->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  342. // Get the action map for the editor, and add each item to the "Common" section.
  343. for (const KeyValue<StringName, InputMap::Action> &E : InputMap::get_singleton()->get_action_map()) {
  344. const String &action_name = E.key;
  345. const InputMap::Action &action = E.value;
  346. // Skip non-builtin actions.
  347. if (!InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().has(action_name)) {
  348. continue;
  349. }
  350. const List<Ref<InputEvent>> &all_default_events = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(action_name)->value;
  351. Array action_events = _event_list_to_array_helper(action.inputs);
  352. if (!_should_display_shortcut(action_name, action_events)) {
  353. continue;
  354. }
  355. Array default_events = _event_list_to_array_helper(all_default_events);
  356. bool same_as_defaults = Shortcut::is_event_array_equal(default_events, action_events);
  357. bool collapse = !collapsed.has(action_name) || (collapsed.has(action_name) && collapsed[action_name]);
  358. _create_shortcut_treeitem(common_section, action_name, action_name, action_events, !same_as_defaults, true, collapse);
  359. }
  360. // Editor Shortcuts
  361. List<String> slist;
  362. EditorSettings::get_singleton()->get_shortcut_list(&slist);
  363. slist.sort(); // Sort alphabetically.
  364. const EditorPropertyNameProcessor::Style name_style = EditorPropertyNameProcessor::get_settings_style();
  365. const EditorPropertyNameProcessor::Style tooltip_style = EditorPropertyNameProcessor::get_tooltip_style(name_style);
  366. // Create all sections first.
  367. for (const String &E : slist) {
  368. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(E);
  369. String section_name = E.get_slice("/", 0);
  370. if (sections.has(section_name)) {
  371. continue;
  372. }
  373. TreeItem *section = shortcuts->create_item(root);
  374. const String item_name = EditorPropertyNameProcessor::get_singleton()->process_name(section_name, name_style, E);
  375. const String tooltip = EditorPropertyNameProcessor::get_singleton()->process_name(section_name, tooltip_style, E);
  376. section->set_text(0, item_name);
  377. section->set_tooltip_text(0, tooltip);
  378. section->set_selectable(0, false);
  379. section->set_selectable(1, false);
  380. section->set_custom_bg_color(0, shortcuts->get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  381. section->set_custom_bg_color(1, shortcuts->get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)));
  382. if (collapsed.has(item_name)) {
  383. section->set_collapsed(collapsed[item_name]);
  384. }
  385. sections[section_name] = section;
  386. }
  387. // Add shortcuts to sections.
  388. for (const String &E : slist) {
  389. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(E);
  390. if (!sc->has_meta("original")) {
  391. continue;
  392. }
  393. String section_name = E.get_slice("/", 0);
  394. TreeItem *section = sections[section_name];
  395. if (!_should_display_shortcut(sc->get_name(), sc->get_events())) {
  396. continue;
  397. }
  398. Array original = sc->get_meta("original");
  399. Array shortcuts_array = sc->get_events().duplicate(true);
  400. bool same_as_defaults = Shortcut::is_event_array_equal(original, shortcuts_array);
  401. bool collapse = !collapsed.has(E) || (collapsed.has(E) && collapsed[E]);
  402. _create_shortcut_treeitem(section, E, sc->get_name(), shortcuts_array, !same_as_defaults, false, collapse);
  403. }
  404. // remove sections with no shortcuts
  405. for (KeyValue<String, TreeItem *> &E : sections) {
  406. TreeItem *section = E.value;
  407. if (section->get_first_child() == nullptr) {
  408. root->remove_child(section);
  409. memdelete(section);
  410. }
  411. }
  412. }
  413. void EditorSettingsDialog::_shortcut_button_pressed(Object *p_item, int p_column, int p_idx, MouseButton p_button) {
  414. if (p_button != MouseButton::LEFT) {
  415. return;
  416. }
  417. TreeItem *ti = Object::cast_to<TreeItem>(p_item);
  418. ERR_FAIL_NULL_MSG(ti, "Object passed is not a TreeItem.");
  419. ShortcutButton button_idx = (ShortcutButton)p_idx;
  420. is_editing_action = ti->get_meta("is_action");
  421. String type = ti->get_meta("type");
  422. if (type == "event") {
  423. current_edited_identifier = ti->get_parent()->get_meta("shortcut_identifier");
  424. current_events = ti->get_parent()->get_meta("events");
  425. current_event_index = ti->get_meta("event_index");
  426. } else { // Type is "shortcut"
  427. current_edited_identifier = ti->get_meta("shortcut_identifier");
  428. current_events = ti->get_meta("events");
  429. current_event_index = -1;
  430. }
  431. switch (button_idx) {
  432. case EditorSettingsDialog::SHORTCUT_ADD: {
  433. // Only for "shortcut" types
  434. shortcut_editor->popup_and_configure();
  435. } break;
  436. case EditorSettingsDialog::SHORTCUT_EDIT: {
  437. // Only for "event" types
  438. shortcut_editor->popup_and_configure(current_events[current_event_index]);
  439. } break;
  440. case EditorSettingsDialog::SHORTCUT_ERASE: {
  441. if (type == "shortcut") {
  442. if (is_editing_action) {
  443. _update_builtin_action(current_edited_identifier, Array());
  444. } else {
  445. _update_shortcut_events(current_edited_identifier, Array());
  446. }
  447. } else if (type == "event") {
  448. current_events.remove_at(current_event_index);
  449. if (is_editing_action) {
  450. _update_builtin_action(current_edited_identifier, current_events);
  451. } else {
  452. _update_shortcut_events(current_edited_identifier, current_events);
  453. }
  454. }
  455. } break;
  456. case EditorSettingsDialog::SHORTCUT_REVERT: {
  457. // Only for "shortcut" types
  458. if (is_editing_action) {
  459. List<Ref<InputEvent>> defaults = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied()[current_edited_identifier];
  460. Array events = _event_list_to_array_helper(defaults);
  461. _update_builtin_action(current_edited_identifier, events);
  462. } else {
  463. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(current_edited_identifier);
  464. Array original = sc->get_meta("original");
  465. _update_shortcut_events(current_edited_identifier, original);
  466. }
  467. } break;
  468. default:
  469. break;
  470. }
  471. }
  472. void EditorSettingsDialog::_shortcut_cell_double_clicked() {
  473. // When a shortcut cell is double clicked:
  474. // If the cell has children and is in the bindings column, and if its first child is editable,
  475. // then uncollapse the cell, and if the first child is the only child, then edit that child.
  476. // If the cell is in the bindings column and can be edited, then edit it.
  477. // If the cell is in the name column, then toggle collapse.
  478. const ShortcutButton edit_btn_id = EditorSettingsDialog::SHORTCUT_EDIT;
  479. const int edit_btn_col = 1;
  480. TreeItem *ti = shortcuts->get_selected();
  481. if (ti == nullptr) {
  482. return;
  483. }
  484. String type = ti->get_meta("type");
  485. int col = shortcuts->get_selected_column();
  486. if (type == "shortcut" && col == 0) {
  487. if (ti->get_first_child()) {
  488. ti->set_collapsed(!ti->is_collapsed());
  489. }
  490. } else if (type == "shortcut" && col == 1) {
  491. if (ti->get_first_child()) {
  492. TreeItem *child_ti = ti->get_first_child();
  493. if (child_ti->get_button_by_id(edit_btn_col, edit_btn_id) != -1) {
  494. ti->set_collapsed(false);
  495. if (ti->get_child_count() == 1) {
  496. _shortcut_button_pressed(child_ti, edit_btn_col, edit_btn_id);
  497. }
  498. }
  499. }
  500. } else if (type == "event" && col == 1) {
  501. if (ti->get_button_by_id(edit_btn_col, edit_btn_id) != -1) {
  502. _shortcut_button_pressed(ti, edit_btn_col, edit_btn_id);
  503. }
  504. }
  505. }
  506. Variant EditorSettingsDialog::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  507. TreeItem *selected = shortcuts->get_selected();
  508. // Only allow drag for events
  509. if (!selected || (String)selected->get_meta("type", "") != "event") {
  510. return Variant();
  511. }
  512. String label_text = "Event " + itos(selected->get_meta("event_index"));
  513. Label *label = memnew(Label(label_text));
  514. label->set_modulate(Color(1, 1, 1, 1.0f));
  515. shortcuts->set_drag_preview(label);
  516. shortcuts->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
  517. return Dictionary(); // No data required
  518. }
  519. bool EditorSettingsDialog::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  520. TreeItem *selected = shortcuts->get_selected();
  521. TreeItem *item = shortcuts->get_item_at_position(p_point);
  522. if (!selected || !item || item == selected || (String)item->get_meta("type", "") != "event") {
  523. return false;
  524. }
  525. // Don't allow moving an events in-between shortcuts.
  526. if (selected->get_parent()->get_meta("shortcut_identifier") != item->get_parent()->get_meta("shortcut_identifier")) {
  527. return false;
  528. }
  529. return true;
  530. }
  531. void EditorSettingsDialog::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  532. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  533. return;
  534. }
  535. TreeItem *selected = shortcuts->get_selected();
  536. TreeItem *target = shortcuts->get_item_at_position(p_point);
  537. if (!target) {
  538. return;
  539. }
  540. int target_event_index = target->get_meta("event_index");
  541. int index_moving_from = selected->get_meta("event_index");
  542. Array events = selected->get_parent()->get_meta("events");
  543. Variant event_moved = events[index_moving_from];
  544. events.remove_at(index_moving_from);
  545. events.insert(target_event_index, event_moved);
  546. String ident = selected->get_parent()->get_meta("shortcut_identifier");
  547. if (selected->get_meta("is_action")) {
  548. _update_builtin_action(ident, events);
  549. } else {
  550. _update_shortcut_events(ident, events);
  551. }
  552. }
  553. void EditorSettingsDialog::_tabs_tab_changed(int p_tab) {
  554. _focus_current_search_box();
  555. }
  556. void EditorSettingsDialog::_focus_current_search_box() {
  557. Control *tab = tabs->get_current_tab_control();
  558. LineEdit *current_search_box = nullptr;
  559. if (tab == tab_general) {
  560. current_search_box = search_box;
  561. } else if (tab == tab_shortcuts) {
  562. current_search_box = shortcut_search_box;
  563. }
  564. if (current_search_box) {
  565. current_search_box->grab_focus();
  566. current_search_box->select_all();
  567. }
  568. }
  569. void EditorSettingsDialog::_editor_restart() {
  570. EditorNode::get_singleton()->save_all_scenes();
  571. EditorNode::get_singleton()->restart_editor();
  572. }
  573. void EditorSettingsDialog::_editor_restart_request() {
  574. restart_container->show();
  575. }
  576. void EditorSettingsDialog::_editor_restart_close() {
  577. restart_container->hide();
  578. }
  579. void EditorSettingsDialog::_bind_methods() {
  580. ClassDB::bind_method(D_METHOD("_update_shortcuts"), &EditorSettingsDialog::_update_shortcuts);
  581. ClassDB::bind_method(D_METHOD("_settings_changed"), &EditorSettingsDialog::_settings_changed);
  582. }
  583. EditorSettingsDialog::EditorSettingsDialog() {
  584. set_title(TTR("Editor Settings"));
  585. set_clamp_to_embedder(true);
  586. tabs = memnew(TabContainer);
  587. tabs->set_theme_type_variation("TabContainerOdd");
  588. tabs->connect("tab_changed", callable_mp(this, &EditorSettingsDialog::_tabs_tab_changed));
  589. add_child(tabs);
  590. // General Tab
  591. tab_general = memnew(VBoxContainer);
  592. tabs->add_child(tab_general);
  593. tab_general->set_name(TTR("General"));
  594. HBoxContainer *hbc = memnew(HBoxContainer);
  595. hbc->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  596. tab_general->add_child(hbc);
  597. search_box = memnew(LineEdit);
  598. search_box->set_placeholder(TTR("Filter Settings"));
  599. search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  600. hbc->add_child(search_box);
  601. inspector = memnew(SectionedInspector);
  602. inspector->get_inspector()->set_use_filter(true);
  603. inspector->register_search_box(search_box);
  604. inspector->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  605. tab_general->add_child(inspector);
  606. inspector->get_inspector()->connect("property_edited", callable_mp(this, &EditorSettingsDialog::_settings_property_edited));
  607. inspector->get_inspector()->connect("restart_requested", callable_mp(this, &EditorSettingsDialog::_editor_restart_request));
  608. restart_container = memnew(PanelContainer);
  609. tab_general->add_child(restart_container);
  610. HBoxContainer *restart_hb = memnew(HBoxContainer);
  611. restart_container->add_child(restart_hb);
  612. restart_icon = memnew(TextureRect);
  613. restart_icon->set_v_size_flags(Control::SIZE_SHRINK_CENTER);
  614. restart_hb->add_child(restart_icon);
  615. restart_label = memnew(Label);
  616. restart_label->set_text(TTR("The editor must be restarted for changes to take effect."));
  617. restart_hb->add_child(restart_label);
  618. restart_hb->add_spacer();
  619. Button *restart_button = memnew(Button);
  620. restart_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsDialog::_editor_restart));
  621. restart_hb->add_child(restart_button);
  622. restart_button->set_text(TTR("Save & Restart"));
  623. restart_close_button = memnew(Button);
  624. restart_close_button->set_flat(true);
  625. restart_close_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsDialog::_editor_restart_close));
  626. restart_hb->add_child(restart_close_button);
  627. restart_container->hide();
  628. // Shortcuts Tab
  629. tab_shortcuts = memnew(VBoxContainer);
  630. tabs->add_child(tab_shortcuts);
  631. tab_shortcuts->set_name(TTR("Shortcuts"));
  632. HBoxContainer *top_hbox = memnew(HBoxContainer);
  633. top_hbox->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  634. tab_shortcuts->add_child(top_hbox);
  635. shortcut_search_box = memnew(LineEdit);
  636. shortcut_search_box->set_placeholder(TTR("Filter by Name"));
  637. shortcut_search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  638. top_hbox->add_child(shortcut_search_box);
  639. shortcut_search_box->connect("text_changed", callable_mp(this, &EditorSettingsDialog::_filter_shortcuts));
  640. shortcut_search_by_event = memnew(EventListenerLineEdit);
  641. shortcut_search_by_event->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  642. shortcut_search_by_event->set_stretch_ratio(0.75);
  643. shortcut_search_by_event->set_allowed_input_types(INPUT_KEY);
  644. shortcut_search_by_event->connect("event_changed", callable_mp(this, &EditorSettingsDialog::_filter_shortcuts_by_event));
  645. shortcut_search_by_event->connect(SceneStringName(focus_entered), callable_mp((AcceptDialog *)this, &AcceptDialog::set_close_on_escape).bind(false));
  646. shortcut_search_by_event->connect(SceneStringName(focus_exited), callable_mp((AcceptDialog *)this, &AcceptDialog::set_close_on_escape).bind(true));
  647. top_hbox->add_child(shortcut_search_by_event);
  648. Button *clear_all_search = memnew(Button);
  649. clear_all_search->set_text(TTR("Clear All"));
  650. clear_all_search->connect(SceneStringName(pressed), callable_mp(shortcut_search_box, &LineEdit::clear));
  651. clear_all_search->connect(SceneStringName(pressed), callable_mp(shortcut_search_by_event, &EventListenerLineEdit::clear_event));
  652. top_hbox->add_child(clear_all_search);
  653. shortcuts = memnew(Tree);
  654. shortcuts->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  655. shortcuts->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  656. shortcuts->set_columns(2);
  657. shortcuts->set_hide_root(true);
  658. shortcuts->set_column_titles_visible(true);
  659. shortcuts->set_column_title(0, TTR("Name"));
  660. shortcuts->set_column_title(1, TTR("Binding"));
  661. shortcuts->connect("button_clicked", callable_mp(this, &EditorSettingsDialog::_shortcut_button_pressed));
  662. shortcuts->connect("item_activated", callable_mp(this, &EditorSettingsDialog::_shortcut_cell_double_clicked));
  663. tab_shortcuts->add_child(shortcuts);
  664. SET_DRAG_FORWARDING_GCD(shortcuts, EditorSettingsDialog);
  665. // Adding event dialog
  666. shortcut_editor = memnew(InputEventConfigurationDialog);
  667. shortcut_editor->connect("confirmed", callable_mp(this, &EditorSettingsDialog::_event_config_confirmed));
  668. shortcut_editor->set_allowed_input_types(INPUT_KEY);
  669. add_child(shortcut_editor);
  670. set_hide_on_ok(true);
  671. timer = memnew(Timer);
  672. timer->set_wait_time(1.5);
  673. timer->connect("timeout", callable_mp(this, &EditorSettingsDialog::_settings_save));
  674. timer->set_one_shot(true);
  675. add_child(timer);
  676. EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &EditorSettingsDialog::_settings_changed));
  677. set_ok_button_text(TTR("Close"));
  678. }
  679. EditorSettingsDialog::~EditorSettingsDialog() {
  680. }