259ed1d400
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.
117 lines
4.5 KiB
C++
117 lines
4.5 KiB
C++
/*************************************************************************/
|
|
/* menu_button.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2018 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 "menu_button.h"
|
|
#include "os/keyboard.h"
|
|
#include "scene/main/viewport.h"
|
|
|
|
void MenuButton::_unhandled_key_input(Ref<InputEvent> p_event) {
|
|
|
|
if (disable_shortcuts)
|
|
return;
|
|
|
|
if (p_event->is_pressed() && !p_event->is_echo() && (Object::cast_to<InputEventKey>(p_event.ptr()) || Object::cast_to<InputEventJoypadButton>(p_event.ptr()) || Object::cast_to<InputEventAction>(*p_event))) {
|
|
|
|
if (!get_parent() || !is_visible_in_tree() || is_disabled())
|
|
return;
|
|
|
|
bool global_only = (get_viewport()->get_modal_stack_top() && !get_viewport()->get_modal_stack_top()->is_a_parent_of(this));
|
|
|
|
if (popup->activate_item_by_event(p_event, global_only))
|
|
accept_event();
|
|
}
|
|
}
|
|
|
|
void MenuButton::pressed() {
|
|
|
|
emit_signal("about_to_show");
|
|
Size2 size = get_size();
|
|
|
|
Point2 gp = get_global_position();
|
|
popup->set_global_position(gp + Size2(0, size.height));
|
|
popup->set_size(Size2(size.width, 0));
|
|
popup->set_parent_rect(Rect2(Point2(gp - popup->get_global_position()), get_size()));
|
|
popup->popup();
|
|
}
|
|
|
|
void MenuButton::_gui_input(Ref<InputEvent> p_event) {
|
|
|
|
BaseButton::_gui_input(p_event);
|
|
}
|
|
|
|
PopupMenu *MenuButton::get_popup() const {
|
|
|
|
return popup;
|
|
}
|
|
|
|
Array MenuButton::_get_items() const {
|
|
|
|
return popup->get("items");
|
|
}
|
|
void MenuButton::_set_items(const Array &p_items) {
|
|
|
|
popup->set("items", p_items);
|
|
}
|
|
|
|
void MenuButton::_bind_methods() {
|
|
|
|
ClassDB::bind_method(D_METHOD("get_popup"), &MenuButton::get_popup);
|
|
ClassDB::bind_method(D_METHOD("_unhandled_key_input"), &MenuButton::_unhandled_key_input);
|
|
ClassDB::bind_method(D_METHOD("_set_items"), &MenuButton::_set_items);
|
|
ClassDB::bind_method(D_METHOD("_get_items"), &MenuButton::_get_items);
|
|
ClassDB::bind_method(D_METHOD("set_disable_shortcuts", "disabled"), &MenuButton::set_disable_shortcuts);
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "items", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL), "_set_items", "_get_items");
|
|
|
|
ADD_SIGNAL(MethodInfo("about_to_show"));
|
|
}
|
|
|
|
void MenuButton::set_disable_shortcuts(bool p_disabled) {
|
|
|
|
disable_shortcuts = p_disabled;
|
|
}
|
|
|
|
MenuButton::MenuButton() {
|
|
|
|
set_flat(true);
|
|
set_disable_shortcuts(false);
|
|
set_enabled_focus_mode(FOCUS_NONE);
|
|
popup = memnew(PopupMenu);
|
|
popup->hide();
|
|
add_child(popup);
|
|
popup->set_as_toplevel(true);
|
|
popup->set_pass_on_modal_close_click(false);
|
|
set_process_unhandled_key_input(true);
|
|
set_action_mode(ACTION_MODE_BUTTON_PRESS);
|
|
}
|
|
|
|
MenuButton::~MenuButton() {
|
|
}
|