Merge pull request #16947 from Faless/ui_actions

GUI elements ui_action usage, improvements

core/input_map.cpp

@@ -282,6 +282,16 @@ void InputMap::load_default() {
 	key->set_scancode(KEY_PAGEDOWN);
 	action_add_event("ui_page_down", key);
 
+	add_action("ui_home");
+	key.instance();
+	key->set_scancode(KEY_HOME);
+	action_add_event("ui_home", key);
+
+	add_action("ui_end");
+	key.instance();
+	key->set_scancode(KEY_END);
+	action_add_event("ui_end", key);
+
 	//set("display/window/handheld/orientation", "landscape");
 }
 

core/project_settings.cpp

@@ -1030,6 +1030,20 @@ ProjectSettings::ProjectSettings() {
 	GLOBAL_DEF("input/ui_page_down", va);
 	input_presets.push_back("input/ui_page_down");
 
+	va = Array();
+	key.instance();
+	key->set_scancode(KEY_HOME);
+	va.push_back(key);
+	GLOBAL_DEF("input/ui_home", va);
+	input_presets.push_back("input/ui_home");
+
+	va = Array();
+	key.instance();
+	key->set_scancode(KEY_END);
+	va.push_back(key);
+	GLOBAL_DEF("input/ui_end", va);
+	input_presets.push_back("input/ui_end");
+
 	//GLOBAL_DEF("display/window/handheld/orientation", "landscape");
 
 	custom_prop_info["display/window/handheld/orientation"] = PropertyInfo(Variant::STRING, "display/window/handheld/orientation", PROPERTY_HINT_ENUM, "landscape,portrait,reverse_landscape,reverse_portrait,sensor_landscape,sensor_portrait,sensor");

scene/gui/line_edit.cpp

@@ -373,12 +373,14 @@ void LineEdit::_gui_input(Ref<InputEvent> p_event) {
 				case KEY_UP: {
 
 					shift_selection_check_pre(k->get_shift());
+					if (get_cursor_position() == 0) handled = false;
 					set_cursor_position(0);
 					shift_selection_check_post(k->get_shift());
 				} break;
 				case KEY_DOWN: {
 
 					shift_selection_check_pre(k->get_shift());
+					if (get_cursor_position() == text.length()) handled = false;
 					set_cursor_position(text.length());
 					shift_selection_check_post(k->get_shift());
 				} break;

scene/gui/option_button.cpp

@@ -75,6 +75,10 @@ void OptionButton::_notification(int p_what) {
 	}
 }
 
+void OptionButton::_focused(int p_which) {
+	emit_signal("item_focused", p_which);
+}
+
 void OptionButton::_selected(int p_which) {
 
 	int selid = -1;
@@ -290,6 +294,7 @@ void OptionButton::get_translatable_strings(List<String> *p_strings) const {
 void OptionButton::_bind_methods() {
 
 	ClassDB::bind_method(D_METHOD("_selected"), &OptionButton::_selected);
+	ClassDB::bind_method(D_METHOD("_focused"), &OptionButton::_focused);
 
 	ClassDB::bind_method(D_METHOD("add_item", "label", "id"), &OptionButton::add_item, DEFVAL(-1));
 	ClassDB::bind_method(D_METHOD("add_icon_item", "texture", "label", "id"), &OptionButton::add_icon_item);
@@ -322,6 +327,7 @@ void OptionButton::_bind_methods() {
 	// "selected" property must come after "items", otherwise GH-10213 occurs
 	ADD_PROPERTY(PropertyInfo(Variant::INT, "selected"), "_select_int", "get_selected");
 	ADD_SIGNAL(MethodInfo("item_selected", PropertyInfo(Variant::INT, "ID")));
+	ADD_SIGNAL(MethodInfo("item_focused", PropertyInfo(Variant::INT, "ID")));
 }
 
 OptionButton::OptionButton() {
@@ -336,6 +342,7 @@ OptionButton::OptionButton() {
 	popup->set_as_toplevel(true);
 	popup->set_pass_on_modal_close_click(false);
 	popup->connect("id_pressed", this, "_selected");
+	popup->connect("id_focused", this, "_focused");
 }
 
 OptionButton::~OptionButton() {

scene/gui/option_button.h

@@ -43,6 +43,7 @@ class OptionButton : public Button {
 	PopupMenu *popup;
 	int current;
 
+	void _focused(int p_which);
 	void _selected(int p_which);
 	void _select(int p_which, bool p_emit = false);
 	void _select_int(int p_which);

scene/gui/popup_menu.cpp

@@ -211,16 +211,7 @@ void PopupMenu::_scroll(float p_factor, const Point2 &p_over) {
 
 void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
 
-	Ref<InputEventKey> k = p_event;
+	if (p_event->is_action("ui_down") && p_event->is_pressed()) {
-
-	if (k.is_valid()) {
-
-		if (!k->is_pressed())
-			return;
-
-		switch (k->get_scancode()) {
-
-			case KEY_DOWN: {
 
 		int search_from = mouse_over + 1;
 		if (search_from >= items.size())
@@ -234,12 +225,13 @@ void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
 			if (!items[i].separator && !items[i].disabled) {
 
 				mouse_over = i;
+				emit_signal("id_focused", i);
 				update();
+				accept_event();
 				break;
 			}
 		}
-			} break;
+	} else if (p_event->is_action("ui_up") && p_event->is_pressed()) {
-			case KEY_UP: {
 
 		int search_from = mouse_over - 1;
 		if (search_from < 0)
@@ -253,44 +245,35 @@ void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
 			if (!items[i].separator && !items[i].disabled) {
 
 				mouse_over = i;
+				emit_signal("id_focused", i);
 				update();
+				accept_event();
 				break;
 			}
 		}
-			} break;
+	} else if (p_event->is_action("ui_left") && p_event->is_pressed()) {
-
-			case KEY_LEFT: {
 
 		Node *n = get_parent();
-				if (!n)
+		if (n && Object::cast_to<PopupMenu>(n)) {
-					break;
-
-				PopupMenu *pm = Object::cast_to<PopupMenu>(n);
-				if (!pm)
-					break;
-
 			hide();
-			} break;
+			accept_event();
+		}
+	} else if (p_event->is_action("ui_right") && p_event->is_pressed()) {
 
-			case KEY_RIGHT: {
+		if (mouse_over >= 0 && mouse_over < items.size() && !items[mouse_over].separator && items[mouse_over].submenu != "" && submenu_over != mouse_over) {
-
-				if (mouse_over >= 0 && mouse_over < items.size() && !items[mouse_over].separator && items[mouse_over].submenu != "" && submenu_over != mouse_over)
 			_activate_submenu(mouse_over);
-			} break;
+			accept_event();
-
+		}
-			case KEY_ENTER:
+	} else if (p_event->is_action("ui_accept") && p_event->is_pressed()) {
-			case KEY_KP_ENTER: {
 
 		if (mouse_over >= 0 && mouse_over < items.size() && !items[mouse_over].separator) {
 
 			if (items[mouse_over].submenu != "" && submenu_over != mouse_over) {
 				_activate_submenu(mouse_over);
-						break;
+			} else {
-					}
-
 				activate_item(mouse_over);
 			}
-			} break;
+			accept_event();
 		}
 	}
 
@@ -1229,6 +1212,7 @@ void PopupMenu::_bind_methods() {
 	ADD_PROPERTYNO(PropertyInfo(Variant::BOOL, "hide_on_state_item_selection"), "set_hide_on_state_item_selection", "is_hide_on_state_item_selection");
 
 	ADD_SIGNAL(MethodInfo("id_pressed", PropertyInfo(Variant::INT, "ID")));
+	ADD_SIGNAL(MethodInfo("id_focused", PropertyInfo(Variant::INT, "ID")));
 	ADD_SIGNAL(MethodInfo("index_pressed", PropertyInfo(Variant::INT, "index")));
 }
 

scene/gui/scroll_bar.cpp

@@ -199,54 +199,40 @@ void ScrollBar::_gui_input(Ref<InputEvent> p_event) {
 		}
 	}
 
-	Ref<InputEventKey> k = p_event;
+	if (p_event->is_pressed()) {
 
-	if (k.is_valid()) {
+		if (p_event->is_action("ui_left")) {
-
-		if (!k->is_pressed())
-			return;
-
-		switch (k->get_scancode()) {
-
-			case KEY_LEFT: {
 
 			if (orientation != HORIZONTAL)
 				return;
 			set_value(get_value() - (custom_step >= 0 ? custom_step : get_step()));
 
-			} break;
+		} else if (p_event->is_action("ui_right")) {
-			case KEY_RIGHT: {
 
 			if (orientation != HORIZONTAL)
 				return;
 			set_value(get_value() + (custom_step >= 0 ? custom_step : get_step()));
 
-			} break;
+		} else if (p_event->is_action("ui_up")) {
-			case KEY_UP: {
 
 			if (orientation != VERTICAL)
 				return;
 
 			set_value(get_value() - (custom_step >= 0 ? custom_step : get_step()));
 
-			} break;
+		} else if (p_event->is_action("ui_down")) {
-			case KEY_DOWN: {
 
 			if (orientation != VERTICAL)
 				return;
 			set_value(get_value() + (custom_step >= 0 ? custom_step : get_step()));
 
-			} break;
+		} else if (p_event->is_action("ui_home")) {
-			case KEY_HOME: {
 
 			set_value(get_min());
 
-			} break;
+		} else if (p_event->is_action("ui_end")) {
-			case KEY_END: {
 
 			set_value(get_max());
-
-			} break;
 		}
 	}
 }

scene/gui/slider.cpp

@@ -118,28 +118,14 @@ void Slider::_gui_input(Ref<InputEvent> p_event) {
 				return;
 			set_value(get_value() - (custom_step >= 0 ? custom_step : get_step()));
 			accept_event();
-
+		} else if (p_event->is_action("ui_home") && p_event->is_pressed()) {
-		} else {
-
-			Ref<InputEventKey> k = p_event;
-
-			if (!k.is_valid() || !k->is_pressed())
-				return;
-
-			switch (k->get_scancode()) {
-
-				case KEY_HOME: {
 
 			set_value(get_min());
 			accept_event();
-				} break;
+		} else if (p_event->is_action("ui_end") && p_event->is_pressed()) {
-				case KEY_END: {
 
 			set_value(get_max());
 			accept_event();
-
-				} break;
-			}
 		}
 	}
 }

scene/gui/tree.cpp

@@ -2061,136 +2061,8 @@ void Tree::popup_select(int p_option) {
 	item_edited(popup_edited_item_col, popup_edited_item);
 }
 
-void Tree::_gui_input(Ref<InputEvent> p_event) {
+void Tree::_go_left() {
-
+	if (selected_col == 0) {
-	Ref<InputEventKey> k = p_event;
-
-	if (k.is_valid()) {
-
-		if (!k->is_pressed())
-			return;
-		if (k->get_command() || (k->get_shift() && k->get_unicode() == 0) || k->get_metakey())
-			return;
-		if (!root)
-			return;
-
-		if (hide_root && !root->get_next_visible())
-			return;
-
-		switch (k->get_scancode()) {
-#define EXIT_BREAK                                 \
-	{                                              \
-		if (!cursor_can_exit_tree) accept_event(); \
-		break;                                     \
-	}
-			case KEY_RIGHT: {
-				bool dobreak = true;
-
-				//TreeItem *next = NULL;
-				if (!selected_item)
-					break;
-				if (select_mode == SELECT_ROW) {
-					EXIT_BREAK;
-				}
-				if (selected_col > (columns.size() - 1)) {
-					EXIT_BREAK;
-				}
-				if (k->get_alt()) {
-					selected_item->set_collapsed(false);
-					TreeItem *next = selected_item->get_children();
-					while (next && next != selected_item->next) {
-						next->set_collapsed(false);
-						next = next->get_next_visible();
-					}
-				} else if (selected_col == (columns.size() - 1)) {
-					if (selected_item->get_children() != NULL && selected_item->is_collapsed()) {
-						selected_item->set_collapsed(false);
-					} else {
-						selected_col = 0;
-						dobreak = false; // fall through to key_down
-					}
-				} else {
-					if (select_mode == SELECT_MULTI) {
-						selected_col++;
-						emit_signal("cell_selected");
-					} else {
-
-						selected_item->select(selected_col + 1);
-					}
-				}
-				update();
-				ensure_cursor_is_visible();
-				accept_event();
-				if (dobreak) {
-					break;
-				}
-			}
-			case KEY_DOWN: {
-
-				TreeItem *next = NULL;
-				if (!selected_item) {
-
-					next = hide_root ? root->get_next_visible() : root;
-					selected_item = 0;
-				} else {
-
-					next = selected_item->get_next_visible();
-
-					//if (diff < uint64_t(GLOBAL_DEF("gui/incr_search_max_interval_msec",2000))) {
-					if (last_keypress != 0) {
-						//incr search next
-						int col;
-						next = _search_item_text(next, incr_search, &col, true);
-						if (!next) {
-							accept_event();
-							return;
-						}
-					}
-				}
-
-				if (select_mode == SELECT_MULTI) {
-
-					if (!next)
-						EXIT_BREAK;
-
-					selected_item = next;
-					emit_signal("cell_selected");
-					update();
-				} else {
-
-					int col = selected_col < 0 ? 0 : selected_col;
-
-					while (next && !next->cells[col].selectable)
-						next = next->get_next_visible();
-					if (!next)
-						EXIT_BREAK; // do nothing..
-					next->select(col);
-				}
-
-				ensure_cursor_is_visible();
-				accept_event();
-
-			} break;
-			case KEY_LEFT: {
-				bool dobreak = true;
-
-				//TreeItem *next = NULL;
-				if (!selected_item)
-					break;
-				if (select_mode == SELECT_ROW) {
-					EXIT_BREAK;
-				}
-				if (selected_col < 0) {
-					EXIT_BREAK;
-				}
-				if (k->get_alt()) {
-					selected_item->set_collapsed(true);
-					TreeItem *next = selected_item->get_children();
-					while (next && next != selected_item->next) {
-						next->set_collapsed(true);
-						next = next->get_next_visible();
-					}
-				} else if (selected_col == 0) {
 		if (selected_item->get_children() != NULL && !selected_item->is_collapsed()) {
 			selected_item->set_collapsed(true);
 		} else {
@@ -2199,9 +2071,9 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 				if (selected_item != get_root() && parent && parent->is_selectable(selected_col) && !(hide_root && parent == get_root())) {
 					select_single_item(parent, get_root(), selected_col);
 				}
-						} else {
+			} else if (selected_item->get_prev_visible()) {
 				selected_col = columns.size() - 1;
-							dobreak = false; // fall through to key_up
+				_go_up(); // go to upper column if possible
 			}
 		}
 	} else {
@@ -2216,13 +2088,32 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 	update();
 	accept_event();
 	ensure_cursor_is_visible();
+}
 
-				if (dobreak) {
+void Tree::_go_right() {
-					break;
+	if (selected_col == (columns.size() - 1)) {
+		if (selected_item->get_children() != NULL && selected_item->is_collapsed()) {
+			selected_item->set_collapsed(false);
+		} else if (selected_item->get_next_visible()) {
+			selected_item->select(0);
+			_go_down();
+			return;
+		}
+	} else {
+		if (select_mode == SELECT_MULTI) {
+			selected_col++;
+			emit_signal("cell_selected");
+		} else {
+
+			selected_item->select(selected_col + 1);
 		}
 	}
-			case KEY_UP: {
+	update();
+	ensure_cursor_is_visible();
+	accept_event();
+}
 
+void Tree::_go_up() {
 	TreeItem *prev = NULL;
 	if (!selected_item) {
 		prev = get_last_item();
@@ -2244,7 +2135,7 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 	if (select_mode == SELECT_MULTI) {
 
 		if (!prev)
-						break;
+			return;
 		selected_item = prev;
 		emit_signal("cell_selected");
 		update();
@@ -2254,19 +2145,119 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 		while (prev && !prev->cells[col].selectable)
 			prev = prev->get_prev_visible();
 		if (!prev)
-						break; // do nothing..
+			return; // do nothing..
 		prev->select(col);
 	}
 
 	ensure_cursor_is_visible();
 	accept_event();
+}
 
-			} break;
+void Tree::_go_down() {
-			case KEY_PAGEDOWN: {
+	TreeItem *next = NULL;
+	if (!selected_item) {
+
+		next = hide_root ? root->get_next_visible() : root;
+		selected_item = 0;
+	} else {
+
+		next = selected_item->get_next_visible();
+
+		if (last_keypress != 0) {
+			//incr search next
+			int col;
+			next = _search_item_text(next, incr_search, &col, true);
+			if (!next) {
+				accept_event();
+				return;
+			}
+		}
+	}
+
+	if (select_mode == SELECT_MULTI) {
+
+		if (!next) {
+			return;
+		}
+
+		selected_item = next;
+		emit_signal("cell_selected");
+		update();
+	} else {
+
+		int col = selected_col < 0 ? 0 : selected_col;
+
+		while (next && !next->cells[col].selectable)
+			next = next->get_next_visible();
+		if (!next) {
+			return; // do nothing..
+		}
+		next->select(col);
+	}
+
+	ensure_cursor_is_visible();
+	accept_event();
+}
+
+void Tree::_gui_input(Ref<InputEvent> p_event) {
+
+	Ref<InputEventKey> k = p_event;
+
+	if (p_event->is_action("ui_right") && p_event->is_pressed()) {
+
+		if (!cursor_can_exit_tree) accept_event();
+
+		if (!selected_item || select_mode == SELECT_ROW || selected_col > (columns.size() - 1)) {
+			return;
+		}
+		if (k.is_valid() && k->get_alt()) {
+			selected_item->set_collapsed(false);
+			TreeItem *next = selected_item->get_children();
+			while (next && next != selected_item->next) {
+				next->set_collapsed(false);
+				next = next->get_next_visible();
+			}
+		} else {
+			_go_right();
+		}
+	} else if (p_event->is_action("ui_left") && p_event->is_pressed()) {
+
+		if (!cursor_can_exit_tree) accept_event();
+
+		if (!selected_item || select_mode == SELECT_ROW || selected_col < 0) {
+			return;
+		}
+
+		if (k.is_valid() && k->get_alt()) {
+			selected_item->set_collapsed(true);
+			TreeItem *next = selected_item->get_children();
+			while (next && next != selected_item->next) {
+				next->set_collapsed(true);
+				next = next->get_next_visible();
+			}
+		} else {
+			_go_left();
+		}
+
+	} else if (p_event->is_action("ui_up") && p_event->is_pressed()) {
+
+		if (!cursor_can_exit_tree) accept_event();
+
+		_go_up();
+
+	} else if (p_event->is_action("ui_down") && p_event->is_pressed()) {
+
+		if (!cursor_can_exit_tree) accept_event();
+
+		_go_down();
+
+	} else if (p_event->is_action("ui_page_down") && p_event->is_pressed()) {
+
+		if (!cursor_can_exit_tree) accept_event();
 
 		TreeItem *next = NULL;
 		if (!selected_item)
-					break;
+			return;
 		next = selected_item;
 
 		for (int i = 0; i < 10; i++) {
@@ -2276,11 +2267,11 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 				next = _n;
 			} else {
 
-						break;
+				return;
 			}
 		}
 		if (next == selected_item)
-					break;
+			return;
 
 		if (select_mode == SELECT_MULTI) {
 
@@ -2291,18 +2282,20 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 
 			while (next && !next->cells[selected_col].selectable)
 				next = next->get_next_visible();
-					if (!next)
+			if (!next) {
-						EXIT_BREAK; // do nothing..
+				return; // do nothing..
+			}
 			next->select(selected_col);
 		}
 
 		ensure_cursor_is_visible();
-			} break;
+	} else if (p_event->is_action("ui_page_up") && p_event->is_pressed()) {
-			case KEY_PAGEUP: {
+
+		if (!cursor_can_exit_tree) accept_event();
 
 		TreeItem *prev = NULL;
 		if (!selected_item)
-					break;
+			return;
 		prev = selected_item;
 
 		for (int i = 0; i < 10; i++) {
@@ -2312,11 +2305,11 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 				prev = _n;
 			} else {
 
-						break;
+				return;
 			}
 		}
 		if (prev == selected_item)
-					break;
+			return;
 
 		if (select_mode == SELECT_MULTI) {
 
@@ -2327,17 +2320,13 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 
 			while (prev && !prev->cells[selected_col].selectable)
 				prev = prev->get_prev_visible();
-					if (!prev)
+			if (!prev) {
-						EXIT_BREAK; // do nothing..
+				return; // do nothing..
+			}
 			prev->select(selected_col);
 		}
-
 		ensure_cursor_is_visible();
-
+	} else if (p_event->is_action("ui_accept") && p_event->is_pressed()) {
-			} break;
-			case KEY_F2:
-			case KEY_ENTER:
-			case KEY_KP_ENTER: {
 
 		if (selected_item) {
 			//bring up editor if possible
@@ -2347,12 +2336,11 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 			}
 		}
 		accept_event();
+	} else if (p_event->is_action("ui_select") && p_event->is_pressed()) {
 
-			} break;
-			case KEY_SPACE: {
 		if (select_mode == SELECT_MULTI) {
 			if (!selected_item)
-						break;
+				return;
 			if (selected_item->is_selected(selected_col)) {
 				selected_item->deselect(selected_col);
 				emit_signal("multi_selected", selected_item, selected_col, false);
@@ -2362,9 +2350,19 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 			}
 		}
 		accept_event();
+	}
 
-			} break;
+	if (k.is_valid()) { // Incremental search
-			default: {
+
+		if (!k->is_pressed())
+			return;
+		if (k->get_command() || (k->get_shift() && k->get_unicode() == 0) || k->get_metakey())
+			return;
+		if (!root)
+			return;
+
+		if (hide_root && !root->get_next_visible())
+			return;
 
 		if (k->get_unicode() > 0) {
 
@@ -2376,8 +2374,6 @@ void Tree::_gui_input(Ref<InputEvent> p_event) {
 			if (k->get_scancode() != KEY_SHIFT)
 				last_keypress = 0;
 		}
-			} break;
-		}
 	}
 
 	Ref<InputEventMouseMotion> mm = p_event;

scene/gui/tree.h

@@ -507,6 +507,10 @@ private:
 	ValueEvaluator *evaluator;
 
 	int _count_selected_items(TreeItem *p_from) const;
+	void _go_left();
+	void _go_right();
+	void _go_down();
+	void _go_up();
 
 protected:
 	static void _bind_methods();

scene/main/viewport.cpp

@@ -2028,6 +2028,9 @@ void Viewport::_gui_input_event(Ref<InputEvent> p_event) {
 				top->notification(Control::NOTIFICATION_MODAL_CLOSE);
 				top->_modal_stack_remove();
 				top->hide();
+				// Close modal, set input as handled
+				get_tree()->set_input_as_handled();
+				return;
 			}
 		}