Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Improve popup menus usability

Browse source 
It seems that popups were intended to "grab" the mouse click that triggered them, but their intent was being lost. This commit does the necessary changes to let it happen and updates items that were trying to get advantage of it, because the semantics of `Control::grab_click_focus()` have changed a bit. Namely, it must be called **before** showing the modal.

This allows to popup a menu and activate an item in it in a single click-point-release cycle, instead of having to click once to open the menu and once more to pick an item.

This ability is extended even to context menus activated with the RMB (or any other mouse button, for that matter). The editor benefits from this in the context menu of the tree dock, which has been patched to opt-in for this feature.

This improves UX a bit by saving unnecessary clicks.

From now on, `PopupMenu` always grabs the click and also invalidates the first button release unless the mouse has moved (that's what `set_invalidate_click_until_motion()` was doing and now it's removed), so there is no longer the need of doing both things at every point a pop-up menu is shown.
This commit is contained in:
Pedro J. Estébanez 2018-03-27 23:41:27 +02:00
parent 4a5723f59e
commit 259ed1d400
8 changed files with 66 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

64
scene/gui/popup_menu.cpp
View file

@ -284,7 +284,8 @@ void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
if (b->is_pressed())
return;
switch (b->get_button_index()) {
int button_idx = b->get_button_index();
switch (button_idx) {
case BUTTON_WHEEL_DOWN: {
@ -298,30 +299,37 @@ void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
_scroll(b->get_factor(), b->get_position());
}
} break;
case BUTTON_LEFT: {
default: {
// Allow activating item by releasing the LMB or any that was down when the popup appeared
if (button_idx == BUTTON_LEFT || (initial_button_mask & (1 << (button_idx - 1)))) {
int over = _get_mouse_over(b->get_position());
bool was_during_grabbed_click = during_grabbed_click;
during_grabbed_click = false;
if (invalidated_click) {
invalidated_click = false;
break;
int over = _get_mouse_over(b->get_position());
if (invalidated_click) {
invalidated_click = false;
break;
}
if (over < 0) {
if (!was_during_grabbed_click) {
hide();
}
break; //non-activable
}
if (items[over].separator || items[over].disabled)
break;
if (items[over].submenu != "") {
_activate_submenu(over);
return;
}
activate_item(over);
}
if (over < 0) {
hide();
break; //non-activable
}
if (items[over].separator || items[over].disabled)
break;
if (items[over].submenu != "") {
_activate_submenu(over);
return;
}
activate_item(over);
} break;
}
}
//update();
@ -503,6 +511,11 @@ void PopupMenu::_notification(int p_what) {
update();
}
} break;
case NOTIFICATION_POST_POPUP: {
initial_button_mask = Input::get_singleton()->get_mouse_button_mask();
during_grabbed_click = (bool)initial_button_mask;
} break;
case NOTIFICATION_POPUP_HIDE: {
if (mouse_over >= 0) {
@ -1216,15 +1229,20 @@ void PopupMenu::_bind_methods() {
ADD_SIGNAL(MethodInfo("index_pressed", PropertyInfo(Variant::INT, "index")));
}
void PopupMenu::set_invalidate_click_until_motion() {
void PopupMenu::popup(const Rect2 &p_bounds) {
grab_click_focus();
moved = Vector2();
invalidated_click = true;
Popup::popup(p_bounds);
}
PopupMenu::PopupMenu() {
mouse_over = -1;
submenu_over = -1;
initial_button_mask = 0;
during_grabbed_click = false;
set_focus_mode(FOCUS_ALL);
set_as_toplevel(true);