Merge pull request #15286 from guilhermefelipecgs/pr_better_find_doc

Better find in documentation

editor/editor_help.cpp

@@ -526,18 +526,7 @@ void EditorHelp::_unhandled_key_input(const Ref<InputEvent> &p_ev) {
 
 void EditorHelp::_search(const String &) {
 
-	if (search->get_text() == "")
+	find_bar->search_next();
-		return;
-
-	String stext = search->get_text();
-	bool keep = prev_search == stext;
-
-	bool ret = class_desc->search(stext, keep);
-	if (!ret) {
-		class_desc->search(stext, false);
-	}
-
-	prev_search = stext;
 }
 
 void EditorHelp::_class_list_select(const String &p_select) {
@@ -598,14 +587,6 @@ void EditorHelp::_class_desc_select(const String &p_select) {
 }
 
 void EditorHelp::_class_desc_input(const Ref<InputEvent> &p_input) {
-
-	Ref<InputEventMouseButton> mb = p_input;
-
-	if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == 1 && !mb->is_doubleclick()) {
-		class_desc->set_selection_enabled(false);
-		class_desc->set_selection_enabled(true);
-	}
-	set_focused();
 }
 
 void EditorHelp::_add_type(const String &p_type, const String &p_enum) {
@@ -1816,13 +1797,7 @@ void EditorHelp::scroll_to_section(int p_section_index) {
 
 void EditorHelp::popup_search() {
 
-	search_dialog->popup_centered(Size2(250, 80) * EDSCALE);
+	find_bar->popup_search();
-	search->grab_focus();
-}
-
-void EditorHelp::_search_cbk() {
-
-	_search(search->get_text());
 }
 
 String EditorHelp::get_class() {
@@ -1851,7 +1826,6 @@ void EditorHelp::_bind_methods() {
 	ClassDB::bind_method("_request_help", &EditorHelp::_request_help);
 	ClassDB::bind_method("_unhandled_key_input", &EditorHelp::_unhandled_key_input);
 	ClassDB::bind_method("_search", &EditorHelp::_search);
-	ClassDB::bind_method("_search_cbk", &EditorHelp::_search_cbk);
 	ClassDB::bind_method("_help_callback", &EditorHelp::_help_callback);
 
 	ADD_SIGNAL(MethodInfo("go_to_help"));
@@ -1863,6 +1837,10 @@ EditorHelp::EditorHelp() {
 
 	EDITOR_DEF("text_editor/help/sort_functions_alphabetically", true);
 
+	find_bar = memnew(FindBar);
+	add_child(find_bar);
+	find_bar->hide();
+
 	class_desc = memnew(RichTextLabel);
 	add_child(class_desc);
 	class_desc->set_v_size_flags(SIZE_EXPAND_FILL);
@@ -1870,24 +1848,14 @@ EditorHelp::EditorHelp() {
 	class_desc->connect("meta_clicked", this, "_class_desc_select");
 	class_desc->connect("gui_input", this, "_class_desc_input");
 
+	find_bar->set_rich_text_label(class_desc);
+
 	class_desc->set_selection_enabled(true);
 
 	scroll_locked = false;
 	select_locked = false;
-	set_process_unhandled_key_input(true);
+	//set_process_unhandled_key_input(true);
 	class_desc->hide();
-
-	search_dialog = memnew(ConfirmationDialog);
-	add_child(search_dialog);
-	VBoxContainer *search_vb = memnew(VBoxContainer);
-	search_dialog->add_child(search_vb);
-
-	search = memnew(LineEdit);
-	search_dialog->register_text_enter(search);
-	search_vb->add_margin_child(TTR("Search Text"), search);
-	search_dialog->get_ok()->set_text(TTR("Find"));
-	search_dialog->connect("confirmed", this, "_search_cbk");
-	search_dialog->set_hide_on_ok(false);
 }
 
 EditorHelp::~EditorHelp() {
@@ -1964,3 +1932,177 @@ EditorHelpBit::EditorHelpBit() {
 	rich_text->set_override_selected_font_color(false);
 	set_custom_minimum_size(Size2(0, 70 * EDSCALE));
 }
+
+FindBar::FindBar() {
+
+	container = memnew(Control);
+	add_child(container);
+
+	container->set_clip_contents(true);
+	container->set_h_size_flags(SIZE_EXPAND_FILL);
+
+	hbc = memnew(HBoxContainer);
+	container->add_child(hbc);
+
+	vbc_search_text = memnew(VBoxContainer);
+	hbc->add_child(vbc_search_text);
+	vbc_search_text->set_h_size_flags(SIZE_EXPAND_FILL);
+	hbc->set_anchor_and_margin(MARGIN_RIGHT, 1, 0);
+
+	search_text = memnew(LineEdit);
+	vbc_search_text->add_child(search_text);
+	search_text->set_custom_minimum_size(Size2(100 * EDSCALE, 0));
+	search_text->connect("text_changed", this, "_search_text_changed");
+	search_text->connect("text_entered", this, "_search_text_entered");
+
+	find_prev = memnew(ToolButton);
+	hbc->add_child(find_prev);
+	find_prev->set_focus_mode(FOCUS_NONE);
+	find_prev->connect("pressed", this, "_search_prev");
+
+	find_next = memnew(ToolButton);
+	hbc->add_child(find_next);
+	find_next->set_focus_mode(FOCUS_NONE);
+	find_next->connect("pressed", this, "_search_next");
+
+	error_label = memnew(Label);
+	hbc->add_child(error_label);
+	error_label->add_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_color("error_color", "Editor"));
+
+	hide_button = memnew(TextureButton);
+	add_child(hide_button);
+	hide_button->set_focus_mode(FOCUS_NONE);
+	hide_button->set_expand(true);
+	hide_button->set_stretch_mode(TextureButton::STRETCH_KEEP_CENTERED);
+	hide_button->connect("pressed", this, "_hide_pressed");
+}
+
+void FindBar::popup_search() {
+	show();
+	search_text->grab_focus();
+	container->set_custom_minimum_size(Size2(0, hbc->get_size().height));
+}
+
+void FindBar::_notification(int p_what) {
+
+	if (p_what == NOTIFICATION_READY) {
+
+		find_prev->set_icon(get_icon("MoveUp", "EditorIcons"));
+		find_next->set_icon(get_icon("MoveDown", "EditorIcons"));
+		hide_button->set_normal_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_hover_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_pressed_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_custom_minimum_size(hide_button->get_normal_texture()->get_size());
+	} else if (p_what == NOTIFICATION_VISIBILITY_CHANGED) {
+
+		set_process_unhandled_input(is_visible_in_tree());
+	} else if (p_what == EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED) {
+
+		find_prev->set_icon(get_icon("MoveUp", "EditorIcons"));
+		find_next->set_icon(get_icon("MoveDown", "EditorIcons"));
+		hide_button->set_normal_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_hover_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_pressed_texture(get_icon("Close", "EditorIcons"));
+		hide_button->set_custom_minimum_size(hide_button->get_normal_texture()->get_size());
+	}
+}
+
+void FindBar::_bind_methods() {
+
+	ClassDB::bind_method("_unhandled_input", &FindBar::_unhandled_input);
+
+	ClassDB::bind_method("_search_text_changed", &FindBar::_search_text_changed);
+	ClassDB::bind_method("_search_text_entered", &FindBar::_search_text_entered);
+	ClassDB::bind_method("_search_next", &FindBar::search_next);
+	ClassDB::bind_method("_search_prev", &FindBar::search_prev);
+	ClassDB::bind_method("_hide_pressed", &FindBar::_hide_bar);
+
+	ADD_SIGNAL(MethodInfo("search"));
+}
+
+void FindBar::set_rich_text_label(RichTextLabel *p_rich_text_label) {
+
+	rich_text_label = p_rich_text_label;
+}
+
+bool FindBar::search_next() {
+
+	return _search();
+}
+
+bool FindBar::search_prev() {
+
+	return _search(true);
+}
+
+bool FindBar::_search(bool p_search_previous) {
+
+	String stext = search_text->get_text();
+	bool keep = prev_search == stext;
+
+	bool ret = rich_text_label->search(stext, keep, p_search_previous);
+	if (!ret) {
+		ret = rich_text_label->search(stext, false, p_search_previous);
+	}
+
+	prev_search = stext;
+
+	if (ret) {
+		set_error("");
+	} else {
+		set_error(stext.empty() ? "" : TTR("No Matches"));
+	}
+
+	return ret;
+}
+
+void FindBar::set_error(const String &p_label) {
+
+	error_label->set_text(p_label);
+}
+
+void FindBar::_hide_bar() {
+
+	if (search_text->has_focus())
+		rich_text_label->grab_focus();
+
+	hide();
+}
+
+void FindBar::_unhandled_input(const Ref<InputEvent> &p_event) {
+
+	Ref<InputEventKey> k = p_event;
+	if (k.is_valid()) {
+
+		if (k->is_pressed() && (rich_text_label->has_focus() || hbc->is_a_parent_of(get_focus_owner()))) {
+
+			bool accepted = true;
+
+			switch (k->get_scancode()) {
+
+				case KEY_ESCAPE: {
+
+					_hide_bar();
+				} break;
+				default: {
+
+					accepted = false;
+				} break;
+			}
+
+			if (accepted) {
+				accept_event();
+			}
+		}
+	}
+}
+
+void FindBar::_search_text_changed(const String &p_text) {
+
+	search_next();
+}
+
+void FindBar::_search_text_entered(const String &p_text) {
+
+	search_next();
+}

editor/editor_help.h

@@ -125,6 +125,50 @@ public:
 	EditorHelpIndex();
 };
 
+class FindBar : public HBoxContainer {
+
+	GDCLASS(FindBar, HBoxContainer);
+
+	LineEdit *search_text;
+	ToolButton *find_prev;
+	ToolButton *find_next;
+	Label *error_label;
+	TextureButton *hide_button;
+	String prev_search;
+
+	Control *container;
+	HBoxContainer *hbc;
+	VBoxContainer *vbc_search_text;
+
+	RichTextLabel *rich_text_label;
+
+	void _show_search();
+	void _hide_bar();
+
+	void _search_text_changed(const String &p_text);
+	void _search_text_entered(const String &p_text);
+
+protected:
+	void _notification(int p_what);
+	void _unhandled_input(const Ref<InputEvent> &p_event);
+
+	bool _search(bool p_search_previous = false);
+
+	static void _bind_methods();
+
+public:
+	void set_error(const String &p_label);
+
+	void set_rich_text_label(RichTextLabel *p_rich_text_label);
+
+	void popup_search();
+
+	bool search_prev();
+	bool search_next();
+
+	FindBar();
+};
+
 class EditorHelp : public VBoxContainer {
 	GDCLASS(EditorHelp, VBoxContainer);
 
@@ -161,6 +205,7 @@ class EditorHelp : public VBoxContainer {
 
 	ConfirmationDialog *search_dialog;
 	LineEdit *search;
+	FindBar *find_bar;
 
 	String base_path;
 
@@ -194,7 +239,6 @@ class EditorHelp : public VBoxContainer {
 
 	void _request_help(const String &p_string);
 	void _search(const String &p_str);
-	void _search_cbk();
 
 	void _unhandled_key_input(const Ref<InputEvent> &p_ev);
 

scene/gui/rich_text_label.cpp

@@ -86,6 +86,54 @@ RichTextLabel::Item *RichTextLabel::_get_next_item(Item *p_item, bool p_free) {
 	return NULL;
 }
 
+RichTextLabel::Item *RichTextLabel::_get_prev_item(Item *p_item, bool p_free) {
+	if (p_free) {
+
+		if (p_item->subitems.size()) {
+
+			return p_item->subitems.back()->get();
+		} else if (!p_item->parent) {
+			return NULL;
+		} else if (p_item->E->prev()) {
+
+			return p_item->E->prev()->get();
+		} else {
+			//go back until something with a prev is found
+			while (p_item->parent && !p_item->E->prev()) {
+				p_item = p_item->parent;
+			}
+
+			if (p_item->parent)
+				return p_item->E->prev()->get();
+			else
+				return NULL;
+		}
+
+	} else {
+		if (p_item->subitems.size() && p_item->type != ITEM_TABLE) {
+
+			return p_item->subitems.back()->get();
+		} else if (p_item->type == ITEM_FRAME) {
+			return NULL;
+		} else if (p_item->E->prev()) {
+
+			return p_item->E->prev()->get();
+		} else {
+			//go back until something with a prev is found
+			while (p_item->type != ITEM_FRAME && !p_item->E->prev()) {
+				p_item = p_item->parent;
+			}
+
+			if (p_item->type != ITEM_FRAME)
+				return p_item->E->prev()->get();
+			else
+				return NULL;
+		}
+	}
+
+	return NULL;
+}
+
 Rect2 RichTextLabel::_get_text_rect() {
 	Ref<StyleBox> style = get_stylebox("normal");
 	return Rect2(style->get_offset(), get_size() - style->get_minimum_size());
@@ -1889,7 +1937,7 @@ void RichTextLabel::set_selection_enabled(bool p_enabled) {
 	}
 }
 
-bool RichTextLabel::search(const String &p_string, bool p_from_selection) {
+bool RichTextLabel::search(const String &p_string, bool p_from_selection, bool p_search_previous) {
 
 	ERR_FAIL_COND_V(!selection.enabled, false);
 	Item *it = main;
@@ -1938,7 +1986,10 @@ bool RichTextLabel::search(const String &p_string, bool p_from_selection) {
 			}
 		}
 
-		it = _get_next_item(it, true);
+		if (p_search_previous)
+			it = _get_prev_item(it, true);
+		else
+			it = _get_next_item(it, true);
 		charidx = 0;
 	}
 

scene/gui/rich_text_label.h

@@ -285,6 +285,7 @@ private:
 
 	void _gui_input(Ref<InputEvent> p_event);
 	Item *_get_next_item(Item *p_item, bool p_free = false);
+	Item *_get_prev_item(Item *p_item, bool p_free = false);
 
 	Rect2 _get_text_rect();
 
@@ -334,7 +335,7 @@ public:
 	void set_tab_size(int p_spaces);
 	int get_tab_size() const;
 
-	bool search(const String &p_string, bool p_from_selection = false);
+	bool search(const String &p_string, bool p_from_selection = false, bool p_search_previous = false);
 
 	void scroll_to_line(int p_line);
 	int get_line_count() const;