Merge pull request #54372 from bruvzg/text_edit_ui

2 files changed, 494 insertions, 0 deletions

diff --git a/editor/plugins/text_control_editor_plugin.cpp b/editor/plugins/text_control_editor_plugin.cpp
new file mode 100644
index 0000000000..c878c83430
--- /dev/null
+++ b/editor/plugins/text_control_editor_plugin.cpp
@@ -0,0 +1,375 @@
+/*************************************************************************/
+/*  text_control_editor_plugin.cpp                                       */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+#include "text_control_editor_plugin.h"
+
+#include "editor/editor_scale.h"
+
+void TextControlEditor::_notification(int p_notification) {
+	switch (p_notification) {
+		case NOTIFICATION_ENTER_TREE: {
+			if (!EditorFileSystem::get_singleton()->is_connected("filesystem_changed", callable_mp(this, &TextControlEditor::_reload_fonts))) {
+				EditorFileSystem::get_singleton()->connect("filesystem_changed", callable_mp(this, &TextControlEditor::_reload_fonts), make_binds(""));
+			}
+			[[fallthrough]];
+		}
+		case NOTIFICATION_THEME_CHANGED: {
+			clear_formatting->set_icon(get_theme_icon(SNAME("Remove"), SNAME("EditorIcons")));
+		} break;
+		case NOTIFICATION_EXIT_TREE: {
+			if (EditorFileSystem::get_singleton()->is_connected("filesystem_changed", callable_mp(this, &TextControlEditor::_reload_fonts))) {
+				EditorFileSystem::get_singleton()->disconnect("filesystem_changed", callable_mp(this, &TextControlEditor::_reload_fonts));
+			}
+		} break;
+		default:
+			break;
+	}
+}
+
+void TextControlEditor::_find_resources(EditorFileSystemDirectory *p_dir) {
+	for (int i = 0; i < p_dir->get_subdir_count(); i++) {
+		_find_resources(p_dir->get_subdir(i));
+	}
+
+	for (int i = 0; i < p_dir->get_file_count(); i++) {
+		if (p_dir->get_file_type(i) == "FontData") {
+			Ref<FontData> fd = ResourceLoader::load(p_dir->get_file_path(i));
+			if (fd.is_valid()) {
+				String name = fd->get_font_name();
+				String sty = fd->get_font_style_name();
+				if (sty.is_empty()) {
+					sty = "Default";
+				}
+				fonts[name][sty] = p_dir->get_file_path(i);
+			}
+		}
+	}
+}
+
+void TextControlEditor::_reload_fonts(const String &p_path) {
+	fonts.clear();
+	_find_resources(EditorFileSystem::get_singleton()->get_filesystem());
+	_update_control();
+}
+
+void TextControlEditor::_update_fonts_menu() {
+	font_list->clear();
+	font_list->add_item(TTR("[Theme Default]"), FONT_INFO_THEME_DEFAULT);
+	if (custom_font.is_valid()) {
+		font_list->add_item(TTR("[Custom Font]"), FONT_INFO_USER_CUSTOM);
+	}
+
+	int id = FONT_INFO_ID;
+	for (Map<String, Map<String, String>>::Element *E = fonts.front(); E; E = E->next()) {
+		font_list->add_item(E->key(), id++);
+	}
+
+	if (font_list->get_item_count() > 1) {
+		font_list->show();
+	} else {
+		font_list->hide();
+	}
+}
+
+void TextControlEditor::_update_styles_menu() {
+	font_style_list->clear();
+	if ((font_list->get_selected_id() >= FONT_INFO_ID)) {
+		const String &name = font_list->get_item_text(font_list->get_selected());
+		for (Map<String, String>::Element *E = fonts[name].front(); E; E = E->next()) {
+			font_style_list->add_item(E->key());
+		}
+	} else {
+		font_style_list->add_item("Default");
+	}
+
+	if (font_style_list->get_item_count() > 1) {
+		font_style_list->show();
+	} else {
+		font_style_list->hide();
+	}
+}
+
+void TextControlEditor::_update_control() {
+	if (edited_control) {
+		// Get override names.
+		if (edited_control->is_class("RichTextLabel")) {
+			edited_color = "default_color";
+			edited_font = "normal_font";
+			edited_font_size = "normal_font_size";
+		} else {
+			edited_color = "font_color";
+			edited_font = "font";
+			edited_font_size = "font_size";
+		}
+
+		// Get font override.
+		Ref<Font> font;
+		if (edited_control->has_theme_font_override(edited_font)) {
+			font = edited_control->get_theme_font(edited_font);
+		}
+		if (font.is_valid()) {
+			if (font->get_data_count() != 1) {
+				// Composite font, save it to "custom_font" to allow undoing font change.
+				custom_font = font;
+				_update_fonts_menu();
+				font_list->select(FONT_INFO_USER_CUSTOM);
+				_update_styles_menu();
+				font_style_list->select(0);
+			} else {
+				// Single face font, search for the font with matching name and style.
+				String name = font->get_data(0)->get_font_name();
+				String style = font->get_data(0)->get_font_style_name();
+				if (fonts.has(name) && fonts[name].has(style)) {
+					_update_fonts_menu();
+					for (int i = 0; i < font_list->get_item_count(); i++) {
+						if (font_list->get_item_text(i) == name) {
+							font_list->select(i);
+							break;
+						}
+					}
+					_update_styles_menu();
+					for (int i = 0; i < font_style_list->get_item_count(); i++) {
+						if (font_style_list->get_item_text(i) == style) {
+							font_style_list->select(i);
+							break;
+						}
+					}
+				} else {
+					// Unknown font, save it to "custom_font" to allow undoing font change.
+					custom_font = font;
+					_update_fonts_menu();
+					font_list->select(FONT_INFO_USER_CUSTOM);
+					_update_styles_menu();
+					font_style_list->select(0);
+				}
+			}
+		} else {
+			// No font override, select "Theme Default".
+			_update_fonts_menu();
+			font_list->select(FONT_INFO_THEME_DEFAULT);
+			_update_styles_menu();
+			font_style_list->select(0);
+		}
+
+		// Get other theme overrides.
+		font_size_list->set_value(edited_control->get_theme_font_size(edited_font_size));
+		outline_size_list->set_value(edited_control->get_theme_constant("outline_size"));
+
+		font_color_picker->set_pick_color(edited_control->get_theme_color(edited_color));
+		outline_color_picker->set_pick_color(edited_control->get_theme_color("font_outline_color"));
+	}
+}
+
+void TextControlEditor::_font_selected(int p_id) {
+	_update_styles_menu();
+	_set_font();
+}
+
+void TextControlEditor::_font_style_selected(int p_id) {
+	_set_font();
+}
+
+void TextControlEditor::_set_font() {
+	if (edited_control) {
+		if (font_list->get_selected_id() == FONT_INFO_THEME_DEFAULT) {
+			// Remove font override.
+			edited_control->remove_theme_font_override(edited_font);
+			return;
+		} else if (font_list->get_selected_id() == FONT_INFO_USER_CUSTOM) {
+			// Restore "custom_font".
+			edited_control->add_theme_font_override(edited_font, custom_font);
+			return;
+		} else {
+			// Load new font resource using selected name and style.
+			String name = font_list->get_item_text(font_list->get_selected());
+			String sty = font_style_list->get_item_text(font_style_list->get_selected());
+			if (sty.is_empty()) {
+				sty = "Default";
+			}
+			if (fonts.has(name)) {
+				Ref<FontData> fd = ResourceLoader::load(fonts[name][sty]);
+				if (fd.is_valid()) {
+					Ref<Font> f;
+					f.instantiate();
+					f->add_data(fd);
+					edited_control->add_theme_font_override(edited_font, f);
+				}
+			}
+		}
+	}
+}
+
+void TextControlEditor::_font_size_selected(double p_size) {
+	if (edited_control) {
+		edited_control->add_theme_font_size_override(edited_font_size, p_size);
+	}
+}
+
+void TextControlEditor::_outline_size_selected(double p_size) {
+	if (edited_control) {
+		edited_control->add_theme_constant_override("outline_size", p_size);
+	}
+}
+
+void TextControlEditor::_font_color_changed(const Color &p_color) {
+	if (edited_control) {
+		edited_control->add_theme_color_override(edited_color, p_color);
+	}
+}
+
+void TextControlEditor::_outline_color_changed(const Color &p_color) {
+	if (edited_control) {
+		edited_control->add_theme_color_override("font_outline_color", p_color);
+	}
+}
+
+void TextControlEditor::_clear_formatting() {
+	if (edited_control) {
+		edited_control->begin_bulk_theme_override();
+		edited_control->remove_theme_font_override(edited_font);
+		edited_control->remove_theme_font_size_override(edited_font_size);
+		edited_control->remove_theme_color_override(edited_color);
+		edited_control->remove_theme_color_override("font_outline_color");
+		edited_control->remove_theme_constant_override("outline_size");
+		edited_control->end_bulk_theme_override();
+		_update_control();
+	}
+}
+
+void TextControlEditor::edit(Object *p_object) {
+	Control *ctrl = Object::cast_to<Control>(p_object);
+	if (!ctrl) {
+		edited_control = nullptr;
+		custom_font = Ref<Font>();
+	} else {
+		edited_control = ctrl;
+		custom_font = Ref<Font>();
+		_update_control();
+	}
+}
+
+bool TextControlEditor::handles(Object *p_object) const {
+	Control *ctrl = Object::cast_to<Control>(p_object);
+	if (!ctrl) {
+		return false;
+	} else {
+		bool valid = false;
+		ctrl->get("text", &valid);
+		return valid;
+	}
+}
+
+TextControlEditor::TextControlEditor() {
+	add_child(memnew(VSeparator));
+
+	font_list = memnew(OptionButton);
+	font_list->set_flat(true);
+	font_list->set_tooltip(TTR("Font"));
+	add_child(font_list);
+	font_list->connect("item_selected", callable_mp(this, &TextControlEditor::_font_selected));
+
+	font_style_list = memnew(OptionButton);
+	font_style_list->set_flat(true);
+	font_style_list->set_tooltip(TTR("Font style"));
+	font_style_list->set_toggle_mode(true);
+	add_child(font_style_list);
+	font_style_list->connect("item_selected", callable_mp(this, &TextControlEditor::_font_style_selected));
+
+	font_size_list = memnew(SpinBox);
+	font_size_list->set_tooltip(TTR("Font Size"));
+	font_size_list->get_line_edit()->add_theme_constant_override("minimum_character_width", 2);
+	font_size_list->set_min(6);
+	font_size_list->set_step(1);
+	font_size_list->set_max(96);
+	font_size_list->get_line_edit()->set_flat(true);
+	add_child(font_size_list);
+	font_size_list->connect("value_changed", callable_mp(this, &TextControlEditor::_font_size_selected));
+
+	font_color_picker = memnew(ColorPickerButton);
+	font_color_picker->set_custom_minimum_size(Size2(20, 0) * EDSCALE);
+	font_color_picker->set_flat(true);
+	font_color_picker->set_tooltip(TTR("Text Color"));
+	add_child(font_color_picker);
+	font_color_picker->connect("color_changed", callable_mp(this, &TextControlEditor::_font_color_changed));
+
+	add_child(memnew(VSeparator));
+
+	outline_size_list = memnew(SpinBox);
+	outline_size_list->set_tooltip(TTR("Outline Size"));
+	outline_size_list->get_line_edit()->add_theme_constant_override("minimum_character_width", 2);
+	outline_size_list->set_min(0);
+	outline_size_list->set_step(1);
+	outline_size_list->set_max(96);
+	outline_size_list->get_line_edit()->set_flat(true);
+	add_child(outline_size_list);
+	outline_size_list->connect("value_changed", callable_mp(this, &TextControlEditor::_outline_size_selected));
+
+	outline_color_picker = memnew(ColorPickerButton);
+	outline_color_picker->set_custom_minimum_size(Size2(20, 0) * EDSCALE);
+	outline_color_picker->set_flat(true);
+	outline_color_picker->set_tooltip(TTR("Outline Color"));
+	add_child(outline_color_picker);
+	outline_color_picker->connect("color_changed", callable_mp(this, &TextControlEditor::_outline_color_changed));
+
+	add_child(memnew(VSeparator));
+
+	clear_formatting = memnew(Button);
+	clear_formatting->set_flat(true);
+	clear_formatting->set_tooltip(TTR("Clear Formatting"));
+	add_child(clear_formatting);
+	clear_formatting->connect("pressed", callable_mp(this, &TextControlEditor::_clear_formatting));
+}
+
+/*************************************************************************/
+
+void TextControlEditorPlugin::edit(Object *p_object) {
+	text_ctl_editor->edit(p_object);
+}
+
+bool TextControlEditorPlugin::handles(Object *p_object) const {
+	return text_ctl_editor->handles(p_object);
+}
+
+void TextControlEditorPlugin::make_visible(bool p_visible) {
+	if (p_visible) {
+		text_ctl_editor->show();
+	} else {
+		text_ctl_editor->hide();
+		text_ctl_editor->edit(nullptr);
+	}
+}
+
+TextControlEditorPlugin::TextControlEditorPlugin(EditorNode *p_node) {
+	editor = p_node;
+	text_ctl_editor = memnew(TextControlEditor);
+	CanvasItemEditor::get_singleton()->add_control_to_menu_panel(text_ctl_editor);
+
+	text_ctl_editor->hide();
+}
diff --git a/editor/plugins/text_control_editor_plugin.h b/editor/plugins/text_control_editor_plugin.h
new file mode 100644
index 0000000000..7f4aa3754c
--- /dev/null
+++ b/editor/plugins/text_control_editor_plugin.h
@@ -0,0 +1,119 @@
+/*************************************************************************/
+/*  text_control_editor_plugin.h                                         */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+#ifndef TEXT_CONTROL_EDITOR_PLUGIN_H
+#define TEXT_CONTROL_EDITOR_PLUGIN_H
+
+#include "canvas_item_editor_plugin.h"
+#include "editor/editor_file_system.h"
+#include "editor/editor_inspector.h"
+#include "editor/editor_node.h"
+#include "editor/editor_plugin.h"
+#include "scene/gui/color_rect.h"
+#include "scene/gui/menu_button.h"
+#include "scene/gui/option_button.h"
+#include "scene/gui/popup_menu.h"
+
+/*************************************************************************/
+
+class TextControlEditor : public HBoxContainer {
+	GDCLASS(TextControlEditor, HBoxContainer);
+
+	enum FontInfoID {
+		FONT_INFO_THEME_DEFAULT = 0,
+		FONT_INFO_USER_CUSTOM = 1,
+		FONT_INFO_ID = 100,
+	};
+
+	Map<String, Map<String, String>> fonts;
+
+	OptionButton *font_list = nullptr;
+	SpinBox *font_size_list = nullptr;
+	OptionButton *font_style_list = nullptr;
+	ColorPickerButton *font_color_picker = nullptr;
+	SpinBox *outline_size_list = nullptr;
+	ColorPickerButton *outline_color_picker = nullptr;
+	Button *clear_formatting = nullptr;
+
+	Control *edited_control = nullptr;
+	String edited_color;
+	String edited_font;
+	String edited_font_size;
+	Ref<Font> custom_font;
+
+protected:
+	void _notification(int p_notification);
+	static void _bind_methods(){};
+
+	void _find_resources(EditorFileSystemDirectory *p_dir);
+	void _reload_fonts(const String &p_path);
+
+	void _update_fonts_menu();
+	void _update_styles_menu();
+	void _update_control();
+
+	void _font_selected(int p_id);
+	void _font_style_selected(int p_id);
+	void _set_font();
+
+	void _font_size_selected(double p_size);
+	void _outline_size_selected(double p_size);
+
+	void _font_color_changed(const Color &p_color);
+	void _outline_color_changed(const Color &p_color);
+
+	void _clear_formatting();
+
+public:
+	void edit(Object *p_object);
+	bool handles(Object *p_object) const;
+
+	TextControlEditor();
+};
+
+/*************************************************************************/
+
+class TextControlEditorPlugin : public EditorPlugin {
+	GDCLASS(TextControlEditorPlugin, EditorPlugin);
+
+	TextControlEditor *text_ctl_editor;
+	EditorNode *editor;
+
+public:
+	virtual String get_name() const override { return "TextControlFontEditor"; }
+	bool has_main_screen() const override { return false; }
+	virtual void edit(Object *p_object) override;
+	virtual bool handles(Object *p_object) const override;
+	virtual void make_visible(bool p_visible) override;
+
+	TextControlEditorPlugin(EditorNode *p_node);
+};
+
+#endif // TEXT_CONTROL_EDITOR_PLUGIN_H