godot/scene/gui/popup_menu.cpp

1498 lines
45 KiB
C++
Raw Normal View History

2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* popup_menu.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 02:10:30 +01:00
/* */
/* 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. */
/*************************************************************************/
2014-02-10 02:10:30 +01:00
#include "popup_menu.h"
#include "core/input/input_filter.h"
#include "core/os/keyboard.h"
2019-05-11 18:32:53 +02:00
#include "core/os/os.h"
#include "core/print_string.h"
#include "core/translation.h"
2020-03-12 13:37:40 +01:00
#include "scene/gui/control.h"
2014-02-10 02:10:30 +01:00
String PopupMenu::_get_accel_text(int p_item) const {
ERR_FAIL_INDEX_V(p_item, items.size(), String());
if (items[p_item].shortcut.is_valid())
return items[p_item].shortcut->get_as_text();
else if (items[p_item].accel)
return keycode_get_string(items[p_item].accel);
return String();
2014-02-10 02:10:30 +01:00
}
2020-03-12 13:37:40 +01:00
Size2 PopupMenu::_get_contents_minimum_size() const {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
int vseparation = get_theme_constant("vseparation");
int hseparation = get_theme_constant("hseparation");
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
Size2 minsize = get_theme_stylebox("panel")->get_minimum_size();
Ref<Font> font = get_theme_font("font");
2016-03-09 00:00:52 +01:00
float max_w = 0;
float icon_w = 0;
2014-02-10 02:10:30 +01:00
int font_h = font->get_height();
2020-03-12 13:37:40 +01:00
int check_w = MAX(get_theme_icon("checked")->get_width(), get_theme_icon("radio_checked")->get_width()) + hseparation;
int accel_max_w = 0;
bool has_check = false;
2016-03-09 00:00:52 +01:00
for (int i = 0; i < items.size(); i++) {
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
Size2 size;
if (!items[i].icon.is_null()) {
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
Size2 icon_size = items[i].icon->get_size();
size.height = MAX(icon_size.height, font_h);
icon_w = MAX(icon_size.width + hseparation, icon_w);
2014-02-10 02:10:30 +01:00
} else {
2016-03-09 00:00:52 +01:00
size.height = font_h;
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
size.width += items[i].h_ofs;
if (items[i].checkable_type)
has_check = true;
2016-03-09 00:00:52 +01:00
String text = items[i].xl_text;
size.width += font->get_string_size(text).width;
if (i > 0)
size.height += vseparation;
2014-02-10 02:10:30 +01:00
if (items[i].accel || (items[i].shortcut.is_valid() && items[i].shortcut->is_valid())) {
2014-02-10 02:10:30 +01:00
int accel_w = hseparation * 2;
accel_w += font->get_string_size(_get_accel_text(i)).width;
accel_max_w = MAX(accel_w, accel_max_w);
2014-02-10 02:10:30 +01:00
}
if (items[i].submenu != "")
2020-03-12 13:37:40 +01:00
size.width += get_theme_icon("submenu")->get_width();
max_w = MAX(max_w, size.width);
minsize.height += size.height;
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
minsize.width += max_w + icon_w + accel_max_w;
if (has_check)
minsize.width += check_w;
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
return minsize;
}
int PopupMenu::_get_mouse_over(const Point2 &p_over) const {
2014-02-10 02:10:30 +01:00
if (p_over.x < 0 || p_over.x >= get_size().width)
2014-02-10 02:10:30 +01:00
return -1;
2020-03-12 13:37:40 +01:00
Ref<StyleBox> style = get_theme_stylebox("panel");
2016-03-09 00:00:52 +01:00
Point2 ofs = style->get_offset();
2014-02-10 02:10:30 +01:00
if (ofs.y > p_over.y)
2014-02-10 02:10:30 +01:00
return -1;
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
Ref<Font> font = get_theme_font("font");
int vseparation = get_theme_constant("vseparation");
float font_h = font->get_height();
2016-03-09 00:00:52 +01:00
for (int i = 0; i < items.size(); i++) {
2016-03-09 00:00:52 +01:00
ofs.y += vseparation;
2014-02-10 02:10:30 +01:00
float h;
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
if (!items[i].icon.is_null()) {
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
Size2 icon_size = items[i].icon->get_size();
h = MAX(icon_size.height, font_h);
2014-02-10 02:10:30 +01:00
} else {
2016-03-09 00:00:52 +01:00
h = font_h;
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
ofs.y += h;
2014-02-10 02:10:30 +01:00
if (p_over.y < ofs.y) {
return i;
2016-03-09 00:00:52 +01:00
}
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
return -1;
}
void PopupMenu::_activate_submenu(int over) {
Node *n = get_node(items[over].submenu);
2019-08-08 22:11:48 +02:00
ERR_FAIL_COND_MSG(!n, "Item subnode does not exist: " + items[over].submenu + ".");
Popup *pm = Object::cast_to<Popup>(n);
2019-08-08 22:11:48 +02:00
ERR_FAIL_COND_MSG(!pm, "Item subnode is not a Popup: " + items[over].submenu + ".");
2020-03-12 13:37:40 +01:00
if (pm->is_visible())
2014-02-10 02:10:30 +01:00
return; //already visible!
2020-03-12 13:37:40 +01:00
Point2 p = get_position();
Rect2 pr(p, get_size());
2020-03-12 13:37:40 +01:00
Ref<StyleBox> style = get_theme_stylebox("panel");
2015-11-22 15:53:22 +01:00
2020-03-12 13:37:40 +01:00
Point2 pos = p + Point2(get_size().width, items[over]._ofs_cache - style->get_offset().y);
2015-11-22 15:53:22 +01:00
Size2 size = pm->get_size();
// fix pos
2020-03-12 13:37:40 +01:00
if (pos.x + size.width > get_screen_rect().size.width)
pos.x = p.x - size.width;
2015-11-22 15:53:22 +01:00
pm->set_position(pos);
2020-03-12 13:37:40 +01:00
// pm->set_scale(get_global_transform().get_scale());
2014-02-10 02:10:30 +01:00
pm->popup();
PopupMenu *pum = Object::cast_to<PopupMenu>(pm);
2014-02-10 02:10:30 +01:00
if (pum) {
2020-03-12 13:37:40 +01:00
pr.position -= pum->get_position();
2014-02-10 02:10:30 +01:00
pum->clear_autohide_areas();
pum->add_autohide_area(Rect2(pr.position.x, pr.position.y, pr.size.x, items[over]._ofs_cache));
if (over < items.size() - 1) {
int from = items[over + 1]._ofs_cache;
pum->add_autohide_area(Rect2(pr.position.x, pr.position.y + from, pr.size.x, pr.size.y - from));
2014-02-10 02:10:30 +01:00
}
}
}
void PopupMenu::_submenu_timeout() {
if (mouse_over == submenu_over)
2014-02-10 02:10:30 +01:00
_activate_submenu(mouse_over);
submenu_over = -1;
2014-02-10 02:10:30 +01:00
}
void PopupMenu::_scroll(float p_factor, const Point2 &p_over) {
2020-03-12 13:37:40 +01:00
int vseparation = get_theme_constant("vseparation");
Ref<Font> font = get_theme_font("font");
2020-03-12 13:37:40 +01:00
float dy = (vseparation + font->get_height()) * 3 * p_factor;
if (dy > 0) {
2020-03-12 13:37:40 +01:00
const float global_top = get_position().y;
const float limit = global_top < 0 ? -global_top : 0;
dy = MIN(dy, limit);
} else if (dy < 0) {
2020-03-12 13:37:40 +01:00
const float global_bottom = get_position().y + get_size().y;
const float viewport_height = get_screen_rect().size.y;
const float limit = global_bottom > viewport_height ? global_bottom - viewport_height : 0;
dy = -MIN(-dy, limit);
}
set_position(get_position() + Vector2(0, dy));
Ref<InputEventMouseMotion> ie;
ie.instance();
ie->set_position(p_over - Vector2(0, dy));
_gui_input(ie);
}
void PopupMenu::_gui_input(const Ref<InputEvent> &p_event) {
2014-02-10 02:10:30 +01:00
if (p_event->is_action("ui_down") && p_event->is_pressed()) {
2014-02-10 02:10:30 +01:00
int search_from = mouse_over + 1;
if (search_from >= items.size())
search_from = 0;
2014-02-10 02:10:30 +01:00
for (int i = search_from; i < items.size(); i++) {
2014-02-10 02:10:30 +01:00
if (i < 0 || i >= items.size())
continue;
if (!items[i].separator && !items[i].disabled) {
2014-02-10 02:10:30 +01:00
mouse_over = i;
emit_signal("id_focused", i);
2020-03-12 13:37:40 +01:00
control->update();
set_input_as_handled();
break;
}
}
} else if (p_event->is_action("ui_up") && p_event->is_pressed()) {
int search_from = mouse_over - 1;
if (search_from < 0)
search_from = items.size() - 1;
for (int i = search_from; i >= 0; i--) {
2019-04-08 11:03:37 +02:00
if (i >= items.size())
continue;
if (!items[i].separator && !items[i].disabled) {
mouse_over = i;
emit_signal("id_focused", i);
2020-03-12 13:37:40 +01:00
control->update();
set_input_as_handled();
break;
}
}
} else if (p_event->is_action("ui_left") && p_event->is_pressed()) {
Node *n = get_parent();
if (n && Object::cast_to<PopupMenu>(n)) {
hide();
2020-03-12 13:37:40 +01:00
set_input_as_handled();
}
} else if (p_event->is_action("ui_right") && p_event->is_pressed()) {
2014-02-10 02:10:30 +01:00
if (mouse_over >= 0 && mouse_over < items.size() && !items[mouse_over].separator && items[mouse_over].submenu != "" && submenu_over != mouse_over) {
_activate_submenu(mouse_over);
2020-03-12 13:37:40 +01:00
set_input_as_handled();
}
} else if (p_event->is_action("ui_accept") && p_event->is_pressed()) {
2014-02-10 02:10:30 +01:00
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);
} else {
activate_item(mouse_over);
}
2020-03-12 13:37:40 +01:00
set_input_as_handled();
}
}
2014-02-10 02:10:30 +01:00
Ref<InputEventMouseButton> b = p_event;
2014-02-10 02:10:30 +01:00
if (b.is_valid()) {
2016-03-09 00:00:52 +01:00
if (b->is_pressed())
return;
2014-02-10 02:10:30 +01:00
int button_idx = b->get_button_index();
switch (button_idx) {
2014-02-10 02:10:30 +01:00
case BUTTON_WHEEL_DOWN: {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
if (get_position().y + get_size().y > get_screen_rect().size.y) {
_scroll(-b->get_factor(), b->get_position());
}
} break;
case BUTTON_WHEEL_UP: {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
if (get_position().y < 0) {
_scroll(b->get_factor(), b->get_position());
}
} break;
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)))) {
bool was_during_grabbed_click = during_grabbed_click;
during_grabbed_click = false;
initial_button_mask = 0;
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);
}
}
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
//control->update();
}
2016-03-09 00:00:52 +01:00
Ref<InputEventMouseMotion> m = p_event;
if (m.is_valid()) {
2014-02-10 02:10:30 +01:00
if (invalidated_click) {
moved += m->get_relative();
if (moved.length() > 4)
invalidated_click = false;
}
2014-02-10 02:10:30 +01:00
for (List<Rect2>::Element *E = autohide_areas.front(); E; E = E->next()) {
2014-02-10 02:10:30 +01:00
if (!Rect2(Point2(), get_size()).has_point(m->get_position()) && E->get().has_point(m->get_position())) {
call_deferred("hide");
return;
2015-11-05 15:22:50 +01:00
}
}
2014-02-10 02:10:30 +01:00
int over = _get_mouse_over(m->get_position());
int id = (over < 0 || items[over].separator || items[over].disabled) ? -1 : (items[over].id >= 0 ? items[over].id : over);
2014-02-10 02:10:30 +01:00
if (id < 0) {
mouse_over = -1;
2020-03-12 13:37:40 +01:00
control->update();
return;
}
if (items[over].submenu != "" && submenu_over != over) {
submenu_over = over;
submenu_timer->start();
}
if (over != mouse_over) {
mouse_over = over;
2020-03-12 13:37:40 +01:00
control->update();
}
2014-02-10 02:10:30 +01:00
}
Ref<InputEventPanGesture> pan_gesture = p_event;
if (pan_gesture.is_valid()) {
2020-03-12 13:37:40 +01:00
if (get_position().y + get_size().y > get_screen_rect().size.y || get_position().y < 0) {
_scroll(-pan_gesture->get_delta().y, pan_gesture->get_position());
}
}
2019-05-11 18:32:53 +02:00
Ref<InputEventKey> k = p_event;
if (allow_search && k.is_valid() && k->get_unicode()) {
uint64_t now = OS::get_singleton()->get_ticks_msec();
uint64_t diff = now - search_time_msec;
uint64_t max_interval = uint64_t(GLOBAL_DEF("gui/timers/incremental_search_max_interval_msec", 2000));
search_time_msec = now;
if (diff > max_interval) {
search_string = "";
}
if (String::chr(k->get_unicode()) != search_string)
search_string += String::chr(k->get_unicode());
for (int i = mouse_over + 1; i <= items.size(); i++) {
if (i == items.size()) {
if (mouse_over <= 0)
break;
else
i = 0;
}
if (i == mouse_over)
break;
if (items[i].text.findn(search_string) == 0) {
mouse_over = i;
emit_signal("id_focused", i);
2020-03-12 13:37:40 +01:00
control->update();
set_input_as_handled();
2019-05-11 18:32:53 +02:00
break;
}
}
}
2014-02-10 02:10:30 +01:00
}
2020-03-12 13:37:40 +01:00
void PopupMenu::_draw() {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
RID ci = control->get_canvas_item();
Size2 size = get_size();
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
Ref<StyleBox> style = get_theme_stylebox("panel");
Ref<StyleBox> hover = get_theme_stylebox("hover");
Ref<Font> font = get_theme_font("font");
// In Item::checkable_type enum order (less the non-checkable member)
Ref<Texture2D> check[] = { get_theme_icon("checked"), get_theme_icon("radio_checked") };
Ref<Texture2D> uncheck[] = { get_theme_icon("unchecked"), get_theme_icon("radio_unchecked") };
Ref<Texture2D> submenu = get_theme_icon("submenu");
Ref<StyleBox> separator = get_theme_stylebox("separator");
Ref<StyleBox> labeled_separator_left = get_theme_stylebox("labeled_separator_left");
Ref<StyleBox> labeled_separator_right = get_theme_stylebox("labeled_separator_right");
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
style->draw(ci, Rect2(Point2(), get_size()));
Point2 ofs = style->get_offset();
int vseparation = get_theme_constant("vseparation");
int hseparation = get_theme_constant("hseparation");
Color font_color = get_theme_color("font_color");
Color font_color_disabled = get_theme_color("font_color_disabled");
Color font_color_accel = get_theme_color("font_color_accel");
Color font_color_hover = get_theme_color("font_color_hover");
float font_h = font->get_height();
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
// Add the check and the wider icon to the offset of all items.
float icon_ofs = 0.0;
bool has_check = false;
for (int i = 0; i < items.size(); i++) {
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
if (!items[i].icon.is_null())
icon_ofs = MAX(items[i].icon->get_size().width, icon_ofs);
2020-03-12 13:37:40 +01:00
if (items[i].checkable_type)
has_check = true;
}
if (icon_ofs > 0.0)
icon_ofs += hseparation;
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
float check_ofs = 0.0;
if (has_check)
check_ofs = MAX(get_theme_icon("checked")->get_width(), get_theme_icon("radio_checked")->get_width()) + hseparation;
2020-03-12 13:37:40 +01:00
for (int i = 0; i < items.size(); i++) {
2020-03-12 13:37:40 +01:00
if (i > 0)
ofs.y += vseparation;
Point2 item_ofs = ofs;
Size2 icon_size;
float h;
2020-03-12 13:37:40 +01:00
if (!items[i].icon.is_null()) {
2020-03-12 13:37:40 +01:00
icon_size = items[i].icon->get_size();
h = MAX(icon_size.height, font_h);
} else {
2020-03-12 13:37:40 +01:00
h = font_h;
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
if (i == mouse_over) {
2020-03-12 13:37:40 +01:00
hover->draw(ci, Rect2(item_ofs + Point2(-hseparation, -vseparation / 2), Size2(get_size().width - style->get_minimum_size().width + hseparation * 2, h + vseparation)));
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
String text = items[i].xl_text;
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
item_ofs.x += items[i].h_ofs;
if (items[i].separator) {
int sep_h = separator->get_center_size().height + separator->get_minimum_size().height;
if (text != String()) {
int ss = font->get_string_size(text).width;
int center = (get_size().width) / 2;
int l = center - ss / 2;
int r = center + ss / 2;
if (l > item_ofs.x) {
labeled_separator_left->draw(ci, Rect2(item_ofs + Point2(0, Math::floor((h - sep_h) / 2.0)), Size2(MAX(0, l - item_ofs.x), sep_h)));
2014-02-10 02:10:30 +01:00
}
2020-03-12 13:37:40 +01:00
if (r < get_size().width - style->get_margin(MARGIN_RIGHT)) {
labeled_separator_right->draw(ci, Rect2(Point2(r, item_ofs.y + Math::floor((h - sep_h) / 2.0)), Size2(MAX(0, get_size().width - style->get_margin(MARGIN_RIGHT) - r), sep_h)));
2014-02-10 02:10:30 +01:00
}
2020-03-12 13:37:40 +01:00
} else {
separator->draw(ci, Rect2(item_ofs + Point2(0, Math::floor((h - sep_h) / 2.0)), Size2(get_size().width - style->get_minimum_size().width, sep_h)));
}
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
Color icon_color(1, 1, 1, items[i].disabled ? 0.5 : 1);
2018-07-14 23:15:42 +02:00
2020-03-12 13:37:40 +01:00
if (items[i].checkable_type) {
Texture2D *icon = (items[i].checked ? check[items[i].checkable_type - 1] : uncheck[items[i].checkable_type - 1]).ptr();
icon->draw(ci, item_ofs + Point2(0, Math::floor((h - icon->get_height()) / 2.0)), icon_color);
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
if (!items[i].icon.is_null()) {
items[i].icon->draw(ci, item_ofs + Size2(check_ofs, 0) + Point2(0, Math::floor((h - icon_size.height) / 2.0)), icon_color);
}
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
if (items[i].submenu != "") {
submenu->draw(ci, Point2(size.width - style->get_margin(MARGIN_RIGHT) - submenu->get_width(), item_ofs.y + Math::floor(h - submenu->get_height()) / 2), icon_color);
}
2020-03-12 13:37:40 +01:00
item_ofs.y += font->get_ascent();
if (items[i].separator) {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
if (text != String()) {
int center = (get_size().width - font->get_string_size(text).width) / 2;
font->draw(ci, Point2(center, item_ofs.y + Math::floor((h - font_h) / 2.0)), text, font_color_disabled);
}
} else {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
item_ofs.x += icon_ofs + check_ofs;
font->draw(ci, item_ofs + Point2(0, Math::floor((h - font_h) / 2.0)), text, items[i].disabled ? font_color_disabled : (i == mouse_over ? font_color_hover : font_color));
}
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
if (items[i].accel || (items[i].shortcut.is_valid() && items[i].shortcut->is_valid())) {
//accelerator
String text2 = _get_accel_text(i);
item_ofs.x = size.width - style->get_margin(MARGIN_RIGHT) - font->get_string_size(text2).width;
font->draw(ci, item_ofs + Point2(0, Math::floor((h - font_h) / 2.0)), text2, i == mouse_over ? font_color_hover : font_color_accel);
}
2018-07-14 23:15:42 +02:00
2020-03-12 13:37:40 +01:00
items.write[i]._ofs_cache = ofs.y;
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
ofs.y += h;
}
}
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
void PopupMenu::_notification(int p_what) {
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
switch (p_what) {
case NOTIFICATION_ENTER_TREE: {
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
PopupMenu *pm = Object::cast_to<PopupMenu>(get_parent());
if (pm) {
// Inherit submenu's popup delay time from parent menu
float pm_delay = pm->get_submenu_popup_delay();
set_submenu_popup_delay(pm_delay);
2014-02-10 02:10:30 +01:00
}
} break;
2020-03-12 13:37:40 +01:00
case NOTIFICATION_TRANSLATION_CHANGED: {
2018-01-02 08:10:49 +01:00
2020-03-12 13:37:40 +01:00
for (int i = 0; i < items.size(); i++) {
items.write[i].xl_text = tr(items[i].text);
}
child_controls_changed();
control->update();
2018-01-02 08:10:49 +01:00
} break;
2020-03-12 13:37:40 +01:00
case NOTIFICATION_WM_MOUSE_ENTER: {
2014-02-10 02:10:30 +01:00
grab_focus();
} break;
2020-03-12 13:37:40 +01:00
case NOTIFICATION_WM_MOUSE_EXIT: {
2016-03-09 00:00:52 +01:00
if (mouse_over >= 0 && (items[mouse_over].submenu == "" || submenu_over != -1)) {
mouse_over = -1;
2020-03-12 13:37:40 +01:00
control->update();
}
} break;
case NOTIFICATION_POST_POPUP: {
initial_button_mask = InputFilter::get_singleton()->get_mouse_button_mask();
during_grabbed_click = (bool)initial_button_mask;
} break;
2020-03-12 13:37:40 +01:00
case NOTIFICATION_VISIBILITY_CHANGED: {
2020-03-12 13:37:40 +01:00
if (!is_visible()) {
if (mouse_over >= 0) {
mouse_over = -1;
control->update();
}
2020-03-12 13:37:40 +01:00
for (int i = 0; i < items.size(); i++) {
if (items[i].submenu == "")
continue;
2020-03-12 13:37:40 +01:00
Node *n = get_node(items[i].submenu);
if (!n)
continue;
2020-03-12 13:37:40 +01:00
PopupMenu *pm = Object::cast_to<PopupMenu>(n);
if (!pm || !pm->is_visible())
continue;
2020-03-12 13:37:40 +01:00
pm->hide();
}
}
2014-02-10 02:10:30 +01:00
} break;
}
}
/* Methods to add items with or without icon, checkbox, shortcut.
* Be sure to keep them in sync when adding new properties in the Item struct.
*/
2014-02-10 02:10:30 +01:00
#define ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel) \
item.text = p_label; \
item.xl_text = tr(p_label); \
item.id = p_id == -1 ? items.size() : p_id; \
item.accel = p_accel;
void PopupMenu::add_item(const String &p_label, int p_id, uint32_t p_accel) {
2014-02-10 02:10:30 +01:00
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
2014-02-10 02:10:30 +01:00
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::add_icon_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id, uint32_t p_accel) {
2014-02-10 02:10:30 +01:00
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.icon = p_icon;
2014-02-10 02:10:30 +01:00
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::add_check_item(const String &p_label, int p_id, uint32_t p_accel) {
2014-02-10 02:10:30 +01:00
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.checkable_type = Item::CHECKABLE_TYPE_CHECK_BOX;
2014-02-10 02:10:30 +01:00
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::add_icon_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id, uint32_t p_accel) {
2014-02-10 02:10:30 +01:00
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.icon = p_icon;
item.checkable_type = Item::CHECKABLE_TYPE_CHECK_BOX;
2014-02-10 02:10:30 +01:00
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::add_radio_check_item(const String &p_label, int p_id, uint32_t p_accel) {
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.checkable_type = Item::CHECKABLE_TYPE_RADIO_BUTTON;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_icon_radio_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id, uint32_t p_accel) {
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.icon = p_icon;
item.checkable_type = Item::CHECKABLE_TYPE_RADIO_BUTTON;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_multistate_item(const String &p_label, int p_max_states, int p_default_state, int p_id, uint32_t p_accel) {
Item item;
ITEM_SETUP_WITH_ACCEL(p_label, p_id, p_accel);
item.max_states = p_max_states;
item.state = p_default_state;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
#define ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global) \
ERR_FAIL_COND_MSG(p_shortcut.is_null(), "Cannot add item with invalid ShortCut."); \
_ref_shortcut(p_shortcut); \
item.text = p_shortcut->get_name(); \
item.xl_text = tr(item.text); \
item.id = p_id == -1 ? items.size() : p_id; \
item.shortcut = p_shortcut; \
item.shortcut_is_global = p_global;
void PopupMenu::add_shortcut(const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_icon_shortcut(const Ref<Texture2D> &p_icon, const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
item.icon = p_icon;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_check_shortcut(const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
item.checkable_type = Item::CHECKABLE_TYPE_CHECK_BOX;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_icon_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
item.icon = p_icon;
item.checkable_type = Item::CHECKABLE_TYPE_CHECK_BOX;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_radio_check_shortcut(const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
item.checkable_type = Item::CHECKABLE_TYPE_RADIO_BUTTON;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_icon_radio_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<ShortCut> &p_shortcut, int p_id, bool p_global) {
Item item;
ITEM_SETUP_WITH_SHORTCUT(p_shortcut, p_id, p_global);
item.icon = p_icon;
item.checkable_type = Item::CHECKABLE_TYPE_RADIO_BUTTON;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::add_submenu_item(const String &p_label, const String &p_submenu, int p_id) {
Item item;
item.text = p_label;
item.xl_text = tr(p_label);
item.id = p_id == -1 ? items.size() : p_id;
item.submenu = p_submenu;
items.push_back(item);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
#undef ITEM_SETUP_WITH_ACCEL
#undef ITEM_SETUP_WITH_SHORTCUT
/* Methods to modify existing items. */
void PopupMenu::set_item_text(int p_idx, const String &p_text) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].text = p_text;
items.write[p_idx].xl_text = tr(p_text);
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_icon(int p_idx, const Ref<Texture2D> &p_icon) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].icon = p_icon;
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_checked(int p_idx, bool p_checked) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
2014-02-10 02:10:30 +01:00
items.write[p_idx].checked = p_checked;
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_id(int p_idx, int p_id) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].id = p_id;
2016-03-09 00:00:52 +01:00
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_accelerator(int p_idx, uint32_t p_accel) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].accel = p_accel;
2014-02-10 02:10:30 +01:00
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_metadata(int p_idx, const Variant &p_meta) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].metadata = p_meta;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_disabled(int p_idx, bool p_disabled) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].disabled = p_disabled;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_submenu(int p_idx, const String &p_submenu) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].submenu = p_submenu;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::toggle_item_checked(int p_idx) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].checked = !items[p_idx].checked;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
2014-02-10 02:10:30 +01:00
String PopupMenu::get_item_text(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), "");
2014-02-10 02:10:30 +01:00
return items[p_idx].text;
}
int PopupMenu::get_item_idx_from_text(const String &text) const {
for (int idx = 0; idx < items.size(); idx++) {
if (items[idx].text == text)
return idx;
}
return -1;
}
Ref<Texture2D> PopupMenu::get_item_icon(int p_idx) const {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX_V(p_idx, items.size(), Ref<Texture2D>());
2014-02-10 02:10:30 +01:00
return items[p_idx].icon;
}
uint32_t PopupMenu::get_item_accelerator(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), 0);
2014-02-10 02:10:30 +01:00
return items[p_idx].accel;
}
Variant PopupMenu::get_item_metadata(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), Variant());
2014-02-10 02:10:30 +01:00
return items[p_idx].metadata;
}
bool PopupMenu::is_item_disabled(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
2014-02-10 02:10:30 +01:00
return items[p_idx].disabled;
}
bool PopupMenu::is_item_checked(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
2014-02-10 02:10:30 +01:00
return items[p_idx].checked;
}
int PopupMenu::get_item_id(int p_idx) const {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX_V(p_idx, items.size(), 0);
return items[p_idx].id;
2014-02-10 02:10:30 +01:00
}
int PopupMenu::get_item_index(int p_id) const {
2014-02-10 02:10:30 +01:00
for (int i = 0; i < items.size(); i++) {
2014-02-10 02:10:30 +01:00
if (items[i].id == p_id)
2014-02-10 02:10:30 +01:00
return i;
}
return -1;
}
String PopupMenu::get_item_submenu(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), "");
2014-02-10 02:10:30 +01:00
return items[p_idx].submenu;
}
String PopupMenu::get_item_tooltip(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), "");
2014-02-10 02:10:30 +01:00
return items[p_idx].tooltip;
}
Ref<ShortCut> PopupMenu::get_item_shortcut(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), Ref<ShortCut>());
return items[p_idx].shortcut;
}
int PopupMenu::get_item_state(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), -1);
return items[p_idx].state;
}
2014-02-10 02:10:30 +01:00
void PopupMenu::set_item_as_separator(int p_idx, bool p_separator) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].separator = p_separator;
2020-03-12 13:37:40 +01:00
control->update();
2014-02-10 02:10:30 +01:00
}
bool PopupMenu::is_item_separator(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
2014-02-10 02:10:30 +01:00
return items[p_idx].separator;
}
void PopupMenu::set_item_as_checkable(int p_idx, bool p_checkable) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].checkable_type = p_checkable ? Item::CHECKABLE_TYPE_CHECK_BOX : Item::CHECKABLE_TYPE_NONE;
2020-03-12 13:37:40 +01:00
control->update();
}
void PopupMenu::set_item_as_radio_checkable(int p_idx, bool p_radio_checkable) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].checkable_type = p_radio_checkable ? Item::CHECKABLE_TYPE_RADIO_BUTTON : Item::CHECKABLE_TYPE_NONE;
2020-03-12 13:37:40 +01:00
control->update();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_tooltip(int p_idx, const String &p_tooltip) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].tooltip = p_tooltip;
2020-03-12 13:37:40 +01:00
control->update();
2014-02-10 02:10:30 +01:00
}
void PopupMenu::set_item_shortcut(int p_idx, const Ref<ShortCut> &p_shortcut, bool p_global) {
ERR_FAIL_INDEX(p_idx, items.size());
if (items[p_idx].shortcut.is_valid()) {
_unref_shortcut(items[p_idx].shortcut);
}
items.write[p_idx].shortcut = p_shortcut;
items.write[p_idx].shortcut_is_global = p_global;
if (items[p_idx].shortcut.is_valid()) {
_ref_shortcut(items[p_idx].shortcut);
}
2020-03-12 13:37:40 +01:00
control->update();
}
void PopupMenu::set_item_h_offset(int p_idx, int p_offset) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].h_ofs = p_offset;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
}
void PopupMenu::set_item_multistate(int p_idx, int p_state) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].state = p_state;
2020-03-12 13:37:40 +01:00
control->update();
}
void PopupMenu::set_item_shortcut_disabled(int p_idx, bool p_disabled) {
ERR_FAIL_INDEX(p_idx, items.size());
items.write[p_idx].shortcut_is_disabled = p_disabled;
2020-03-12 13:37:40 +01:00
control->update();
}
void PopupMenu::toggle_item_multistate(int p_idx) {
ERR_FAIL_INDEX(p_idx, items.size());
if (0 >= items[p_idx].max_states) {
return;
}
++items.write[p_idx].state;
if (items.write[p_idx].max_states <= items[p_idx].state)
items.write[p_idx].state = 0;
2020-03-12 13:37:40 +01:00
control->update();
}
2014-02-10 02:10:30 +01:00
bool PopupMenu::is_item_checkable(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
return items[p_idx].checkable_type;
}
bool PopupMenu::is_item_radio_checkable(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
return items[p_idx].checkable_type == Item::CHECKABLE_TYPE_RADIO_BUTTON;
2014-02-10 02:10:30 +01:00
}
bool PopupMenu::is_item_shortcut_disabled(int p_idx) const {
ERR_FAIL_INDEX_V(p_idx, items.size(), false);
return items[p_idx].shortcut_is_disabled;
}
2014-02-10 02:10:30 +01:00
int PopupMenu::get_item_count() const {
return items.size();
}
bool PopupMenu::activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only) {
uint32_t code = 0;
Ref<InputEventKey> k = p_event;
if (k.is_valid()) {
code = k->get_keycode();
if (code == 0)
code = k->get_unicode();
if (k->get_control())
code |= KEY_MASK_CTRL;
if (k->get_alt())
code |= KEY_MASK_ALT;
if (k->get_metakey())
code |= KEY_MASK_META;
if (k->get_shift())
code |= KEY_MASK_SHIFT;
}
for (int i = 0; i < items.size(); i++) {
if (is_item_disabled(i) || items[i].shortcut_is_disabled)
continue;
2014-02-10 02:10:30 +01:00
if (items[i].shortcut.is_valid() && items[i].shortcut->is_shortcut(p_event) && (items[i].shortcut_is_global || !p_for_global_only)) {
activate_item(i);
return true;
}
if (code != 0 && items[i].accel == code) {
activate_item(i);
return true;
}
if (items[i].submenu != "") {
Node *n = get_node(items[i].submenu);
if (!n)
continue;
PopupMenu *pm = Object::cast_to<PopupMenu>(n);
if (!pm)
continue;
if (pm->activate_item_by_event(p_event, p_for_global_only)) {
return true;
}
}
2014-02-10 02:10:30 +01:00
}
return false;
2014-02-10 02:10:30 +01:00
}
void PopupMenu::activate_item(int p_item) {
ERR_FAIL_INDEX(p_item, items.size());
2014-02-10 02:10:30 +01:00
ERR_FAIL_COND(items[p_item].separator);
int id = items[p_item].id >= 0 ? items[p_item].id : p_item;
2015-08-12 22:24:21 +02:00
//hide all parent PopupMenus
2015-08-12 22:24:21 +02:00
Node *next = get_parent();
PopupMenu *pop = Object::cast_to<PopupMenu>(next);
2015-08-12 22:24:21 +02:00
while (pop) {
// We close all parents that are chained together,
// with hide_on_item_selection enabled
if (items[p_item].checkable_type) {
if (!hide_on_checkable_item_selection || !pop->is_hide_on_checkable_item_selection())
break;
} else if (0 < items[p_item].max_states) {
if (!hide_on_multistate_item_selection || !pop->is_hide_on_multistate_item_selection())
break;
} else if (!hide_on_item_selection || !pop->is_hide_on_item_selection())
break;
pop->hide();
next = next->get_parent();
pop = Object::cast_to<PopupMenu>(next);
}
// Hides popup by default; unless otherwise specified
// by using set_hide_on_item_selection and set_hide_on_checkable_item_selection
bool need_hide = true;
if (items[p_item].checkable_type) {
if (!hide_on_checkable_item_selection)
need_hide = false;
} else if (0 < items[p_item].max_states) {
if (!hide_on_multistate_item_selection)
need_hide = false;
} else if (!hide_on_item_selection)
need_hide = false;
emit_signal("id_pressed", id);
emit_signal("index_pressed", p_item);
if (need_hide) {
hide();
}
2014-02-10 02:10:30 +01:00
}
void PopupMenu::remove_item(int p_idx) {
ERR_FAIL_INDEX(p_idx, items.size());
if (items[p_idx].shortcut.is_valid()) {
_unref_shortcut(items[p_idx].shortcut);
}
2014-02-10 02:10:30 +01:00
items.remove(p_idx);
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
2018-07-14 23:15:42 +02:00
void PopupMenu::add_separator(const String &p_text) {
2014-02-10 02:10:30 +01:00
Item sep;
sep.separator = true;
sep.id = -1;
2018-07-14 23:15:42 +02:00
if (p_text != String()) {
sep.text = p_text;
sep.xl_text = tr(p_text);
}
2014-02-10 02:10:30 +01:00
items.push_back(sep);
2020-03-12 13:37:40 +01:00
control->update();
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
void PopupMenu::clear() {
2014-02-10 02:10:30 +01:00
for (int i = 0; i < items.size(); i++) {
if (items[i].shortcut.is_valid()) {
_unref_shortcut(items[i].shortcut);
}
}
2014-02-10 02:10:30 +01:00
items.clear();
mouse_over = -1;
2020-03-12 13:37:40 +01:00
control->update();
child_controls_changed();
2014-02-10 02:10:30 +01:00
}
Array PopupMenu::_get_items() const {
Array items;
for (int i = 0; i < get_item_count(); i++) {
2014-02-10 02:10:30 +01:00
items.push_back(get_item_text(i));
items.push_back(get_item_icon(i));
// For compatibility, use false/true for no/checkbox and integers for other values
int ct = this->items[i].checkable_type;
items.push_back(Variant(ct <= Item::CHECKABLE_TYPE_CHECK_BOX ? is_item_checkable(i) : ct));
2014-02-10 02:10:30 +01:00
items.push_back(is_item_checked(i));
items.push_back(is_item_disabled(i));
items.push_back(get_item_id(i));
2014-02-10 02:10:30 +01:00
items.push_back(get_item_accelerator(i));
items.push_back(get_item_metadata(i));
items.push_back(get_item_submenu(i));
items.push_back(is_item_separator(i));
}
return items;
}
void PopupMenu::_ref_shortcut(Ref<ShortCut> p_sc) {
if (!shortcut_refcount.has(p_sc)) {
shortcut_refcount[p_sc] = 1;
p_sc->connect("changed", callable_mp((CanvasItem *)this, &CanvasItem::update));
} else {
shortcut_refcount[p_sc] += 1;
}
}
void PopupMenu::_unref_shortcut(Ref<ShortCut> p_sc) {
ERR_FAIL_COND(!shortcut_refcount.has(p_sc));
shortcut_refcount[p_sc]--;
if (shortcut_refcount[p_sc] == 0) {
p_sc->disconnect("changed", callable_mp((CanvasItem *)this, &CanvasItem::update));
shortcut_refcount.erase(p_sc);
}
}
void PopupMenu::_set_items(const Array &p_items) {
2014-02-10 02:10:30 +01:00
ERR_FAIL_COND(p_items.size() % 10);
clear();
for (int i = 0; i < p_items.size(); i += 10) {
String text = p_items[i + 0];
Ref<Texture2D> icon = p_items[i + 1];
// For compatibility, use false/true for no/checkbox and integers for other values
bool checkable = p_items[i + 2];
bool radio_checkable = (int)p_items[i + 2] == Item::CHECKABLE_TYPE_RADIO_BUTTON;
bool checked = p_items[i + 3];
bool disabled = p_items[i + 4];
int id = p_items[i + 5];
int accel = p_items[i + 6];
Variant meta = p_items[i + 7];
String subm = p_items[i + 8];
bool sep = p_items[i + 9];
int idx = get_item_count();
add_item(text, id);
set_item_icon(idx, icon);
if (checkable) {
if (radio_checkable) {
set_item_as_radio_checkable(idx, true);
} else {
set_item_as_checkable(idx, true);
}
}
set_item_checked(idx, checked);
set_item_disabled(idx, disabled);
set_item_id(idx, id);
set_item_metadata(idx, meta);
set_item_as_separator(idx, sep);
set_item_accelerator(idx, accel);
set_item_submenu(idx, subm);
2014-02-10 02:10:30 +01:00
}
}
// Hide on item selection determines whether or not the popup will close after item selection
void PopupMenu::set_hide_on_item_selection(bool p_enabled) {
hide_on_item_selection = p_enabled;
}
bool PopupMenu::is_hide_on_item_selection() const {
return hide_on_item_selection;
}
2014-02-10 02:10:30 +01:00
void PopupMenu::set_hide_on_checkable_item_selection(bool p_enabled) {
hide_on_checkable_item_selection = p_enabled;
}
bool PopupMenu::is_hide_on_checkable_item_selection() const {
return hide_on_checkable_item_selection;
}
void PopupMenu::set_hide_on_multistate_item_selection(bool p_enabled) {
hide_on_multistate_item_selection = p_enabled;
}
bool PopupMenu::is_hide_on_multistate_item_selection() const {
return hide_on_multistate_item_selection;
}
void PopupMenu::set_submenu_popup_delay(float p_time) {
if (p_time <= 0)
p_time = 0.01;
submenu_timer->set_wait_time(p_time);
}
float PopupMenu::get_submenu_popup_delay() const {
return submenu_timer->get_wait_time();
}
2019-05-11 18:32:53 +02:00
void PopupMenu::set_allow_search(bool p_allow) {
allow_search = p_allow;
}
bool PopupMenu::get_allow_search() const {
return allow_search;
}
String PopupMenu::get_tooltip(const Point2 &p_pos) const {
2014-02-10 02:10:30 +01:00
int over = _get_mouse_over(p_pos);
if (over < 0 || over >= items.size())
2014-02-10 02:10:30 +01:00
return "";
return items[over].tooltip;
}
void PopupMenu::set_parent_rect(const Rect2 &p_rect) {
2014-02-10 02:10:30 +01:00
parent_rect = p_rect;
2014-02-10 02:10:30 +01:00
}
void PopupMenu::get_translatable_strings(List<String> *p_strings) const {
for (int i = 0; i < items.size(); i++) {
2014-02-10 02:10:30 +01:00
if (items[i].xl_text != "")
p_strings->push_back(items[i].xl_text);
2014-02-10 02:10:30 +01:00
}
}
void PopupMenu::add_autohide_area(const Rect2 &p_area) {
2014-02-10 02:10:30 +01:00
autohide_areas.push_back(p_area);
}
void PopupMenu::clear_autohide_areas() {
2014-02-10 02:10:30 +01:00
autohide_areas.clear();
}
void PopupMenu::_bind_methods() {
ClassDB::bind_method(D_METHOD("_gui_input"), &PopupMenu::_gui_input);
ClassDB::bind_method(D_METHOD("add_item", "label", "id", "accel"), &PopupMenu::add_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_icon_item", "texture", "label", "id", "accel"), &PopupMenu::add_icon_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_check_item", "label", "id", "accel"), &PopupMenu::add_check_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_icon_check_item", "texture", "label", "id", "accel"), &PopupMenu::add_icon_check_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_radio_check_item", "label", "id", "accel"), &PopupMenu::add_radio_check_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_icon_radio_check_item", "texture", "label", "id", "accel"), &PopupMenu::add_icon_radio_check_item, DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_multistate_item", "label", "max_states", "default_state", "id", "accel"), &PopupMenu::add_multistate_item, DEFVAL(0), DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_shortcut", "shortcut", "id", "global"), &PopupMenu::add_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_icon_shortcut", "texture", "shortcut", "id", "global"), &PopupMenu::add_icon_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_check_shortcut", "shortcut", "id", "global"), &PopupMenu::add_check_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_icon_check_shortcut", "texture", "shortcut", "id", "global"), &PopupMenu::add_icon_check_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_radio_check_shortcut", "shortcut", "id", "global"), &PopupMenu::add_radio_check_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_icon_radio_check_shortcut", "texture", "shortcut", "id", "global"), &PopupMenu::add_icon_radio_check_shortcut, DEFVAL(-1), DEFVAL(false));
ClassDB::bind_method(D_METHOD("add_submenu_item", "label", "submenu", "id"), &PopupMenu::add_submenu_item, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("set_item_text", "idx", "text"), &PopupMenu::set_item_text);
ClassDB::bind_method(D_METHOD("set_item_icon", "idx", "icon"), &PopupMenu::set_item_icon);
ClassDB::bind_method(D_METHOD("set_item_checked", "idx", "checked"), &PopupMenu::set_item_checked);
ClassDB::bind_method(D_METHOD("set_item_id", "idx", "id"), &PopupMenu::set_item_id);
ClassDB::bind_method(D_METHOD("set_item_accelerator", "idx", "accel"), &PopupMenu::set_item_accelerator);
ClassDB::bind_method(D_METHOD("set_item_metadata", "idx", "metadata"), &PopupMenu::set_item_metadata);
ClassDB::bind_method(D_METHOD("set_item_disabled", "idx", "disabled"), &PopupMenu::set_item_disabled);
ClassDB::bind_method(D_METHOD("set_item_submenu", "idx", "submenu"), &PopupMenu::set_item_submenu);
ClassDB::bind_method(D_METHOD("set_item_as_separator", "idx", "enable"), &PopupMenu::set_item_as_separator);
ClassDB::bind_method(D_METHOD("set_item_as_checkable", "idx", "enable"), &PopupMenu::set_item_as_checkable);
ClassDB::bind_method(D_METHOD("set_item_as_radio_checkable", "idx", "enable"), &PopupMenu::set_item_as_radio_checkable);
ClassDB::bind_method(D_METHOD("set_item_tooltip", "idx", "tooltip"), &PopupMenu::set_item_tooltip);
ClassDB::bind_method(D_METHOD("set_item_shortcut", "idx", "shortcut", "global"), &PopupMenu::set_item_shortcut, DEFVAL(false));
ClassDB::bind_method(D_METHOD("set_item_multistate", "idx", "state"), &PopupMenu::set_item_multistate);
ClassDB::bind_method(D_METHOD("set_item_shortcut_disabled", "idx", "disabled"), &PopupMenu::set_item_shortcut_disabled);
ClassDB::bind_method(D_METHOD("toggle_item_checked", "idx"), &PopupMenu::toggle_item_checked);
ClassDB::bind_method(D_METHOD("toggle_item_multistate", "idx"), &PopupMenu::toggle_item_multistate);
ClassDB::bind_method(D_METHOD("get_item_text", "idx"), &PopupMenu::get_item_text);
ClassDB::bind_method(D_METHOD("get_item_icon", "idx"), &PopupMenu::get_item_icon);
ClassDB::bind_method(D_METHOD("is_item_checked", "idx"), &PopupMenu::is_item_checked);
ClassDB::bind_method(D_METHOD("get_item_id", "idx"), &PopupMenu::get_item_id);
ClassDB::bind_method(D_METHOD("get_item_index", "id"), &PopupMenu::get_item_index);
ClassDB::bind_method(D_METHOD("get_item_accelerator", "idx"), &PopupMenu::get_item_accelerator);
ClassDB::bind_method(D_METHOD("get_item_metadata", "idx"), &PopupMenu::get_item_metadata);
ClassDB::bind_method(D_METHOD("is_item_disabled", "idx"), &PopupMenu::is_item_disabled);
ClassDB::bind_method(D_METHOD("get_item_submenu", "idx"), &PopupMenu::get_item_submenu);
ClassDB::bind_method(D_METHOD("is_item_separator", "idx"), &PopupMenu::is_item_separator);
ClassDB::bind_method(D_METHOD("is_item_checkable", "idx"), &PopupMenu::is_item_checkable);
ClassDB::bind_method(D_METHOD("is_item_radio_checkable", "idx"), &PopupMenu::is_item_radio_checkable);
ClassDB::bind_method(D_METHOD("is_item_shortcut_disabled", "idx"), &PopupMenu::is_item_shortcut_disabled);
ClassDB::bind_method(D_METHOD("get_item_tooltip", "idx"), &PopupMenu::get_item_tooltip);
ClassDB::bind_method(D_METHOD("get_item_shortcut", "idx"), &PopupMenu::get_item_shortcut);
ClassDB::bind_method(D_METHOD("get_item_count"), &PopupMenu::get_item_count);
ClassDB::bind_method(D_METHOD("remove_item", "idx"), &PopupMenu::remove_item);
2018-07-14 23:15:42 +02:00
ClassDB::bind_method(D_METHOD("add_separator", "label"), &PopupMenu::add_separator, DEFVAL(String()));
ClassDB::bind_method(D_METHOD("clear"), &PopupMenu::clear);
ClassDB::bind_method(D_METHOD("_set_items"), &PopupMenu::_set_items);
ClassDB::bind_method(D_METHOD("_get_items"), &PopupMenu::_get_items);
ClassDB::bind_method(D_METHOD("set_hide_on_item_selection", "enable"), &PopupMenu::set_hide_on_item_selection);
ClassDB::bind_method(D_METHOD("is_hide_on_item_selection"), &PopupMenu::is_hide_on_item_selection);
ClassDB::bind_method(D_METHOD("set_hide_on_checkable_item_selection", "enable"), &PopupMenu::set_hide_on_checkable_item_selection);
ClassDB::bind_method(D_METHOD("is_hide_on_checkable_item_selection"), &PopupMenu::is_hide_on_checkable_item_selection);
ClassDB::bind_method(D_METHOD("set_hide_on_state_item_selection", "enable"), &PopupMenu::set_hide_on_multistate_item_selection);
ClassDB::bind_method(D_METHOD("is_hide_on_state_item_selection"), &PopupMenu::is_hide_on_multistate_item_selection);
ClassDB::bind_method(D_METHOD("set_submenu_popup_delay", "seconds"), &PopupMenu::set_submenu_popup_delay);
ClassDB::bind_method(D_METHOD("get_submenu_popup_delay"), &PopupMenu::get_submenu_popup_delay);
2018-01-02 08:10:49 +01:00
2019-05-11 18:32:53 +02:00
ClassDB::bind_method(D_METHOD("set_allow_search", "allow"), &PopupMenu::set_allow_search);
ClassDB::bind_method(D_METHOD("get_allow_search"), &PopupMenu::get_allow_search);
ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "items", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL), "_set_items", "_get_items");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "hide_on_item_selection"), "set_hide_on_item_selection", "is_hide_on_item_selection");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "hide_on_checkable_item_selection"), "set_hide_on_checkable_item_selection", "is_hide_on_checkable_item_selection");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "hide_on_state_item_selection"), "set_hide_on_state_item_selection", "is_hide_on_state_item_selection");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "submenu_popup_delay"), "set_submenu_popup_delay", "get_submenu_popup_delay");
2019-05-11 18:32:53 +02:00
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "allow_search"), "set_allow_search", "get_allow_search");
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")));
2014-02-10 02:10:30 +01:00
}
2016-03-09 00:00:52 +01:00
void PopupMenu::popup(const Rect2 &p_bounds) {
moved = Vector2();
invalidated_click = true;
Popup::popup(p_bounds);
}
2014-02-10 02:10:30 +01:00
PopupMenu::PopupMenu() {
2020-03-12 13:37:40 +01:00
control = memnew(Control);
add_child(control);
control->set_anchors_and_margins_preset(Control::PRESET_WIDE);
control->connect("gui_input", callable_mp(this, &PopupMenu::_gui_input));
control->connect("draw", callable_mp(this, &PopupMenu::_draw));
mouse_over = -1;
submenu_over = -1;
initial_button_mask = 0;
during_grabbed_click = false;
2016-03-09 00:00:52 +01:00
2019-05-11 18:32:53 +02:00
allow_search = false;
search_time_msec = 0;
search_string = "";
set_hide_on_item_selection(true);
set_hide_on_checkable_item_selection(true);
set_hide_on_multistate_item_selection(false);
2014-02-10 02:10:30 +01:00
submenu_timer = memnew(Timer);
2014-02-10 02:10:30 +01:00
submenu_timer->set_wait_time(0.3);
submenu_timer->set_one_shot(true);
submenu_timer->connect("timeout", callable_mp(this, &PopupMenu::_submenu_timeout));
2014-02-10 02:10:30 +01:00
add_child(submenu_timer);
}
PopupMenu::~PopupMenu() {
}