Enhancements and fixes for `OptionButton` and `PopupMenu`

4 files changed, 64 insertions, 40 deletions

diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml
index eb1b0aada7..b316f822f0 100644
--- a/doc/classes/PopupMenu.xml
+++ b/doc/classes/PopupMenu.xml
@@ -331,6 +331,13 @@
 				[b]Note:[/b] The indices of items after the removed item will be shifted by one.
 			</description>
 		</method>
+		<method name="scroll_to_item">
+			<return type="void" />
+			<argument index="0" name="index" type="int" />
+			<description>
+				Moves the scroll view to make the item at the given [code]index[/code] visible.
+			</description>
+		</method>
 		<method name="set_current_index">
 			<return type="void" />
 			<argument index="0" name="index" type="int" />
diff --git a/scene/gui/option_button.cpp b/scene/gui/option_button.cpp
index 9984ab240a..0d7304888e 100644
--- a/scene/gui/option_button.cpp
+++ b/scene/gui/option_button.cpp
@@ -115,6 +115,11 @@ void OptionButton::_notification(int p_what) {
 bool OptionButton::_set(const StringName &p_name, const Variant &p_value) {
 	Vector<String> components = String(p_name).split("/", true, 2);
 	if (components.size() >= 2 && components[0] == "popup") {
+		String property = components[2];
+		if (property != "text" && property != "icon" && property != "id" && property != "disabled" && property != "separator") {
+			return false;
+		}
+
 		bool valid;
 		popup->set(String(p_name).trim_prefix("popup/"), p_value, &valid);
 
@@ -133,6 +138,11 @@ bool OptionButton::_set(const StringName &p_name, const Variant &p_value) {
 bool OptionButton::_get(const StringName &p_name, Variant &r_ret) const {
 	Vector<String> components = String(p_name).split("/", true, 2);
 	if (components.size() >= 2 && components[0] == "popup") {
+		String property = components[2];
+		if (property != "text" && property != "icon" && property != "id" && property != "disabled" && property != "separator") {
+			return false;
+		}
+
 		bool valid;
 		r_ret = popup->get(String(p_name).trim_prefix("popup/"), &valid);
 		return valid;
@@ -148,14 +158,6 @@ void OptionButton::_get_property_list(List<PropertyInfo> *p_list) const {
 		pi.usage &= ~(popup->get_item_icon(i).is_null() ? PROPERTY_USAGE_STORAGE : 0);
 		p_list->push_back(pi);
 
-		pi = PropertyInfo(Variant::INT, vformat("popup/item_%d/checkable", i), PROPERTY_HINT_ENUM, "No,As checkbox,As radio button");
-		pi.usage &= ~(!popup->is_item_checkable(i) ? PROPERTY_USAGE_STORAGE : 0);
-		p_list->push_back(pi);
-
-		pi = PropertyInfo(Variant::BOOL, vformat("popup/item_%d/checked", i));
-		pi.usage &= ~(!popup->is_item_checked(i) ? PROPERTY_USAGE_STORAGE : 0);
-		p_list->push_back(pi);
-
 		pi = PropertyInfo(Variant::INT, vformat("popup/item_%d/id", i), PROPERTY_HINT_RANGE, "0,10,1,or_greater");
 		p_list->push_back(pi);
 
@@ -183,10 +185,13 @@ void OptionButton::pressed() {
 	popup->set_size(Size2(size.width, 0));
 
 	// If not triggered by the mouse, start the popup with the checked item selected.
-	if (popup->get_item_count() > 0 &&
-			((get_action_mode() == ActionMode::ACTION_MODE_BUTTON_PRESS && Input::get_singleton()->is_action_just_pressed("ui_accept")) ||
-					(get_action_mode() == ActionMode::ACTION_MODE_BUTTON_RELEASE && Input::get_singleton()->is_action_just_released("ui_accept")))) {
-		popup->set_current_index(current > -1 ? current : 0);
+	if (popup->get_item_count() > 0) {
+		if ((get_action_mode() == ActionMode::ACTION_MODE_BUTTON_PRESS && Input::get_singleton()->is_action_just_pressed("ui_accept")) ||
+				(get_action_mode() == ActionMode::ACTION_MODE_BUTTON_RELEASE && Input::get_singleton()->is_action_just_released("ui_accept"))) {
+			popup->set_current_index(current > -1 ? current : 0);
+		} else {
+			popup->scroll_to_item(current > -1 ? current : 0);
+		}
 	}
 
 	popup->popup();
@@ -264,7 +269,20 @@ bool OptionButton::is_item_disabled(int p_idx) const {
 
 void OptionButton::set_item_count(int p_count) {
 	ERR_FAIL_COND(p_count < 0);
+
+	int count_old = get_item_count();
+	if (p_count == count_old) {
+		return;
+	}
+
 	popup->set_item_count(p_count);
+
+	if (p_count > count_old) {
+		for (int i = count_old; i < p_count; i++) {
+			popup->set_item_as_radio_checkable(i, true);
+		}
+	}
+
 	notify_property_list_changed();
 }
 
@@ -294,7 +312,7 @@ void OptionButton::_select(int p_which, bool p_emit) {
 
 		current = NONE_SELECTED;
 		set_text("");
-		set_icon(NULL);
+		set_icon(nullptr);
 	} else {
 		ERR_FAIL_INDEX(p_which, popup->get_item_count());
 
diff --git a/scene/gui/popup_menu.cpp b/scene/gui/popup_menu.cpp
index 812339dc19..c5e096058f 100644
--- a/scene/gui/popup_menu.cpp
+++ b/scene/gui/popup_menu.cpp
@@ -108,7 +108,6 @@ Size2 PopupMenu::_get_contents_minimum_size() const {
 
 int PopupMenu::_get_item_height(int p_item) const {
 	ERR_FAIL_INDEX_V(p_item, items.size(), 0);
-	ERR_FAIL_COND_V(p_item < 0, 0);
 
 	int icon_height = items[p_item].get_icon_size().height;
 	if (items[p_item].checkable_type) {
@@ -141,23 +140,6 @@ int PopupMenu::_get_items_total_height() const {
 	return items_total_height - vsep;
 }
 
-void PopupMenu::_scroll_to_item(int p_item) {
-	ERR_FAIL_INDEX(p_item, items.size());
-	ERR_FAIL_COND(p_item < 0);
-
-	// Scroll item into view (upwards)
-	if (items[p_item]._ofs_cache < -control->get_position().y) {
-		int amnt_over = items[p_item]._ofs_cache + control->get_position().y;
-		scroll_container->set_v_scroll(scroll_container->get_v_scroll() + amnt_over);
-	}
-
-	// Scroll item into view (downwards)
-	if (items[p_item]._ofs_cache + items[p_item]._height_cache > -control->get_position().y + scroll_container->get_size().height) {
-		int amnt_over = items[p_item]._ofs_cache + items[p_item]._height_cache + control->get_position().y - scroll_container->get_size().height;
-		scroll_container->set_v_scroll(scroll_container->get_v_scroll() + amnt_over);
-	}
-}
-
 int PopupMenu::_get_mouse_over(const Point2 &p_over) const {
 	if (p_over.x < 0 || p_over.x >= get_size().width) {
 		return -1;
@@ -275,7 +257,7 @@ void PopupMenu::gui_input(const Ref<InputEvent> &p_event) {
 			if (!items[i].separator && !items[i].disabled) {
 				mouse_over = i;
 				emit_signal(SNAME("id_focused"), i);
-				_scroll_to_item(i);
+				scroll_to_item(i);
 				control->update();
 				set_input_as_handled();
 				match_found = true;
@@ -289,7 +271,7 @@ void PopupMenu::gui_input(const Ref<InputEvent> &p_event) {
 				if (!items[i].separator && !items[i].disabled) {
 					mouse_over = i;
 					emit_signal(SNAME("id_focused"), i);
-					_scroll_to_item(i);
+					scroll_to_item(i);
 					control->update();
 					set_input_as_handled();
 					break;
@@ -307,7 +289,7 @@ void PopupMenu::gui_input(const Ref<InputEvent> &p_event) {
 			if (!items[i].separator && !items[i].disabled) {
 				mouse_over = i;
 				emit_signal(SNAME("id_focused"), i);
-				_scroll_to_item(i);
+				scroll_to_item(i);
 				control->update();
 				set_input_as_handled();
 				match_found = true;
@@ -321,7 +303,7 @@ void PopupMenu::gui_input(const Ref<InputEvent> &p_event) {
 				if (!items[i].separator && !items[i].disabled) {
 					mouse_over = i;
 					emit_signal(SNAME("id_focused"), i);
-					_scroll_to_item(i);
+					scroll_to_item(i);
 					control->update();
 					set_input_as_handled();
 					break;
@@ -471,7 +453,7 @@ void PopupMenu::gui_input(const Ref<InputEvent> &p_event) {
 			if (items[i].text.findn(search_string) == 0) {
 				mouse_over = i;
 				emit_signal(SNAME("id_focused"), i);
-				_scroll_to_item(i);
+				scroll_to_item(i);
 				control->update();
 				set_input_as_handled();
 				break;
@@ -1281,7 +1263,7 @@ bool PopupMenu::is_item_shortcut_disabled(int p_idx) const {
 void PopupMenu::set_current_index(int p_idx) {
 	ERR_FAIL_INDEX(p_idx, items.size());
 	mouse_over = p_idx;
-	_scroll_to_item(mouse_over);
+	scroll_to_item(mouse_over);
 	control->update();
 }
 
@@ -1309,6 +1291,20 @@ int PopupMenu::get_item_count() const {
 	return items.size();
 }
 
+void PopupMenu::scroll_to_item(int p_item) {
+	ERR_FAIL_INDEX(p_item, items.size());
+
+	// Scroll item into view (upwards).
+	if (items[p_item]._ofs_cache - scroll_container->get_v_scroll() < -control->get_position().y) {
+		scroll_container->set_v_scroll(items[p_item]._ofs_cache + control->get_position().y);
+	}
+
+	// Scroll item into view (downwards).
+	if (items[p_item]._ofs_cache + items[p_item]._height_cache - scroll_container->get_v_scroll() > -control->get_position().y + scroll_container->get_size().height) {
+		scroll_container->set_v_scroll(items[p_item]._ofs_cache + items[p_item]._height_cache + control->get_position().y);
+	}
+}
+
 bool PopupMenu::activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only) {
 	Key code = Key::NONE;
 	Ref<InputEventKey> k = p_event;
@@ -1582,7 +1578,7 @@ bool PopupMenu::_set(const StringName &p_name, const Variant &p_value) {
 		} else if (property == "id") {
 			set_item_id(item_index, p_value);
 			return true;
-		} else if (components[1] == "disabled") {
+		} else if (property == "disabled") {
 			set_item_disabled(item_index, p_value);
 			return true;
 		} else if (property == "separator") {
@@ -1655,7 +1651,7 @@ bool PopupMenu::_get(const StringName &p_name, Variant &r_ret) const {
 		} else if (property == "id") {
 			r_ret = get_item_id(item_index);
 			return true;
-		} else if (components[1] == "disabled") {
+		} else if (property == "disabled") {
 			r_ret = is_item_disabled(item_index);
 			return true;
 		} else if (property == "separator") {
@@ -1761,6 +1757,8 @@ void PopupMenu::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("set_item_count", "count"), &PopupMenu::set_item_count);
 	ClassDB::bind_method(D_METHOD("get_item_count"), &PopupMenu::get_item_count);
 
+	ClassDB::bind_method(D_METHOD("scroll_to_item", "index"), &PopupMenu::scroll_to_item);
+
 	ClassDB::bind_method(D_METHOD("remove_item", "index"), &PopupMenu::remove_item);
 
 	ClassDB::bind_method(D_METHOD("add_separator", "label", "id"), &PopupMenu::add_separator, DEFVAL(String()), DEFVAL(-1));
diff --git a/scene/gui/popup_menu.h b/scene/gui/popup_menu.h
index 7c2212d82d..5ce55209d4 100644
--- a/scene/gui/popup_menu.h
+++ b/scene/gui/popup_menu.h
@@ -103,7 +103,6 @@ class PopupMenu : public Popup {
 
 	int _get_item_height(int p_item) const;
 	int _get_items_total_height() const;
-	void _scroll_to_item(int p_item);
 
 	void _shape_item(int p_item);
 
@@ -218,6 +217,8 @@ public:
 	void set_item_count(int p_count);
 	int get_item_count() const;
 
+	void scroll_to_item(int p_item);
+
 	bool activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only = false);
 	void activate_item(int p_item);