2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* popup_menu.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#ifndef POPUP_MENU_H
|
|
|
|
#define POPUP_MENU_H
|
|
|
|
|
2021-08-22 15:37:22 +00:00
|
|
|
#include "core/input/shortcut.h"
|
2020-08-29 12:05:59 +00:00
|
|
|
#include "scene/gui/margin_container.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
#include "scene/gui/popup.h"
|
2020-08-29 12:05:59 +00:00
|
|
|
#include "scene/gui/scroll_container.h"
|
2020-09-03 11:22:16 +00:00
|
|
|
#include "scene/resources/text_line.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
class PopupMenu : public Popup {
|
2017-01-03 02:03:46 +00:00
|
|
|
GDCLASS(PopupMenu, Popup);
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
struct Item {
|
2019-06-11 18:43:37 +00:00
|
|
|
Ref<Texture2D> icon;
|
2023-03-31 19:17:59 +00:00
|
|
|
int icon_max_width = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
String text;
|
2017-01-09 19:43:44 +00:00
|
|
|
String xl_text;
|
2020-09-03 11:22:16 +00:00
|
|
|
Ref<TextLine> text_buf;
|
|
|
|
Ref<TextLine> accel_text_buf;
|
|
|
|
|
|
|
|
String language;
|
|
|
|
Control::TextDirection text_direction = Control::TEXT_DIRECTION_AUTO;
|
|
|
|
|
2021-02-09 17:24:36 +00:00
|
|
|
bool checked = false;
|
2018-03-23 20:55:40 +00:00
|
|
|
enum {
|
|
|
|
CHECKABLE_TYPE_NONE,
|
|
|
|
CHECKABLE_TYPE_CHECK_BOX,
|
|
|
|
CHECKABLE_TYPE_RADIO_BUTTON,
|
|
|
|
} checkable_type;
|
2021-02-09 17:24:36 +00:00
|
|
|
int max_states = 0;
|
|
|
|
int state = 0;
|
|
|
|
bool separator = false;
|
|
|
|
bool disabled = false;
|
|
|
|
bool dirty = true;
|
|
|
|
int id = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
Variant metadata;
|
|
|
|
String submenu;
|
|
|
|
String tooltip;
|
2021-08-13 21:31:57 +00:00
|
|
|
Key accel = Key::NONE;
|
2021-02-09 17:24:36 +00:00
|
|
|
int _ofs_cache = 0;
|
|
|
|
int _height_cache = 0;
|
2022-08-01 09:28:16 +00:00
|
|
|
int indent = 0;
|
2020-09-09 19:53:24 +00:00
|
|
|
Ref<Shortcut> shortcut;
|
2021-02-09 17:24:36 +00:00
|
|
|
bool shortcut_is_global = false;
|
|
|
|
bool shortcut_is_disabled = false;
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2020-08-29 12:05:59 +00:00
|
|
|
// Returns (0,0) if icon is null.
|
|
|
|
Size2 get_icon_size() const {
|
|
|
|
return icon.is_null() ? Size2() : icon->get_size();
|
|
|
|
}
|
|
|
|
|
2017-01-05 12:16:00 +00:00
|
|
|
Item() {
|
2021-06-17 22:03:09 +00:00
|
|
|
text_buf.instantiate();
|
|
|
|
accel_text_buf.instantiate();
|
2018-03-23 20:55:40 +00:00
|
|
|
checkable_type = CHECKABLE_TYPE_NONE;
|
2017-01-05 12:16:00 +00:00
|
|
|
}
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2020-09-07 12:57:50 +00:00
|
|
|
bool close_allowed = false;
|
2022-04-13 06:58:38 +00:00
|
|
|
bool activated_by_keyboard = false;
|
2020-09-07 12:57:50 +00:00
|
|
|
|
|
|
|
Timer *minimum_lifetime_timer = nullptr;
|
2022-04-04 13:06:57 +00:00
|
|
|
Timer *submenu_timer = nullptr;
|
2014-02-10 01:10:30 +00:00
|
|
|
List<Rect2> autohide_areas;
|
|
|
|
Vector<Item> items;
|
2023-01-07 23:55:54 +00:00
|
|
|
BitField<MouseButtonMask> initial_button_mask;
|
2021-02-09 17:24:36 +00:00
|
|
|
bool during_grabbed_click = false;
|
|
|
|
int mouse_over = -1;
|
|
|
|
int submenu_over = -1;
|
2014-02-10 01:10:30 +00:00
|
|
|
Rect2 parent_rect;
|
2020-09-03 11:22:16 +00:00
|
|
|
String _get_accel_text(const Item &p_item) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
int _get_mouse_over(const Point2 &p_over) const;
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual Size2 _get_contents_minimum_size() const override;
|
2020-08-29 12:05:59 +00:00
|
|
|
|
2021-02-16 03:30:57 +00:00
|
|
|
int _get_item_height(int p_item) const;
|
2020-08-29 12:05:59 +00:00
|
|
|
int _get_items_total_height() const;
|
2023-03-31 19:17:59 +00:00
|
|
|
Size2 _get_item_icon_size(int p_item) const;
|
2020-08-29 12:05:59 +00:00
|
|
|
|
2020-09-03 11:22:16 +00:00
|
|
|
void _shape_item(int p_item);
|
|
|
|
|
2021-08-22 15:37:22 +00:00
|
|
|
virtual void gui_input(const Ref<InputEvent> &p_event);
|
2022-04-13 06:58:38 +00:00
|
|
|
void _activate_submenu(int p_over, bool p_by_keyboard = false);
|
2014-02-10 01:10:30 +00:00
|
|
|
void _submenu_timeout();
|
|
|
|
|
2020-09-18 18:45:59 +00:00
|
|
|
uint64_t popup_time_msec = 0;
|
2021-02-09 17:24:36 +00:00
|
|
|
bool hide_on_item_selection = true;
|
|
|
|
bool hide_on_checkable_item_selection = true;
|
|
|
|
bool hide_on_multistate_item_selection = false;
|
2015-01-03 19:52:37 +00:00
|
|
|
Vector2 moved;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-05-13 13:04:37 +00:00
|
|
|
HashMap<Ref<Shortcut>, int> shortcut_refcount;
|
2016-06-05 00:31:29 +00:00
|
|
|
|
2020-09-09 19:53:24 +00:00
|
|
|
void _ref_shortcut(Ref<Shortcut> p_sc);
|
|
|
|
void _unref_shortcut(Ref<Shortcut> p_sc);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-09-26 13:21:04 +00:00
|
|
|
void _shortcut_changed();
|
|
|
|
|
2021-02-09 17:24:36 +00:00
|
|
|
bool allow_search = true;
|
|
|
|
uint64_t search_time_msec = 0;
|
|
|
|
String search_string = "";
|
2019-05-11 16:32:53 +00:00
|
|
|
|
2022-04-04 13:06:57 +00:00
|
|
|
MarginContainer *margin_container = nullptr;
|
|
|
|
ScrollContainer *scroll_container = nullptr;
|
|
|
|
Control *control = nullptr;
|
2020-03-12 12:37:40 +00:00
|
|
|
|
2022-09-01 10:38:08 +00:00
|
|
|
struct ThemeCache {
|
|
|
|
Ref<StyleBox> panel_style;
|
|
|
|
Ref<StyleBox> hover_style;
|
|
|
|
|
|
|
|
Ref<StyleBox> separator_style;
|
|
|
|
Ref<StyleBox> labeled_separator_left;
|
|
|
|
Ref<StyleBox> labeled_separator_right;
|
|
|
|
|
|
|
|
int v_separation = 0;
|
|
|
|
int h_separation = 0;
|
|
|
|
int indent = 0;
|
|
|
|
int item_start_padding = 0;
|
|
|
|
int item_end_padding = 0;
|
2023-03-31 19:17:59 +00:00
|
|
|
int icon_max_width = 0;
|
2022-09-01 10:38:08 +00:00
|
|
|
|
|
|
|
Ref<Texture2D> checked;
|
|
|
|
Ref<Texture2D> checked_disabled;
|
|
|
|
Ref<Texture2D> unchecked;
|
|
|
|
Ref<Texture2D> unchecked_disabled;
|
|
|
|
Ref<Texture2D> radio_checked;
|
|
|
|
Ref<Texture2D> radio_checked_disabled;
|
|
|
|
Ref<Texture2D> radio_unchecked;
|
|
|
|
Ref<Texture2D> radio_unchecked_disabled;
|
|
|
|
|
|
|
|
Ref<Texture2D> submenu;
|
|
|
|
Ref<Texture2D> submenu_mirrored;
|
|
|
|
|
|
|
|
Ref<Font> font;
|
|
|
|
int font_size = 0;
|
|
|
|
Ref<Font> font_separator;
|
|
|
|
int font_separator_size = 0;
|
|
|
|
|
|
|
|
Color font_color;
|
|
|
|
Color font_hover_color;
|
|
|
|
Color font_disabled_color;
|
|
|
|
Color font_accelerator_color;
|
|
|
|
int font_outline_size = 0;
|
|
|
|
Color font_outline_color;
|
|
|
|
|
|
|
|
Color font_separator_color;
|
|
|
|
int font_separator_outline_size = 0;
|
|
|
|
Color font_separator_outline_color;
|
|
|
|
} theme_cache;
|
|
|
|
|
2020-08-29 12:05:59 +00:00
|
|
|
void _draw_items();
|
|
|
|
void _draw_background();
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2020-09-07 12:57:50 +00:00
|
|
|
void _minimum_lifetime_timeout();
|
|
|
|
void _close_pressed();
|
2022-08-01 09:28:16 +00:00
|
|
|
void _menu_changed();
|
2020-09-07 12:57:50 +00:00
|
|
|
|
2020-03-12 12:37:40 +00:00
|
|
|
protected:
|
2022-09-01 10:38:08 +00:00
|
|
|
virtual void _update_theme_item_cache() override;
|
|
|
|
|
2022-08-01 09:28:16 +00:00
|
|
|
virtual void add_child_notify(Node *p_child) override;
|
|
|
|
virtual void remove_child_notify(Node *p_child) override;
|
2014-02-10 01:10:30 +00:00
|
|
|
void _notification(int p_what);
|
2021-11-03 02:08:58 +00:00
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
2016-03-08 23:00:52 +00:00
|
|
|
static void _bind_methods();
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
public:
|
2021-08-01 05:53:36 +00:00
|
|
|
// ATTENTION: This is used by the POT generator's scene parser. If the number of properties returned by `_get_items()` ever changes,
|
|
|
|
// this value should be updated to reflect the new size.
|
|
|
|
static const int ITEM_PROPERTY_SIZE = 10;
|
|
|
|
|
2022-06-09 08:59:01 +00:00
|
|
|
virtual void _parent_focused() override;
|
|
|
|
|
2021-08-13 21:31:57 +00:00
|
|
|
void add_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
|
|
|
void add_icon_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
|
|
|
void add_check_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
|
|
|
void add_icon_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
|
|
|
void add_radio_check_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
|
|
|
void add_icon_radio_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
|
2019-05-09 09:21:49 +00:00
|
|
|
|
2021-08-13 21:31:57 +00:00
|
|
|
void add_multistate_item(const String &p_label, int p_max_states, int p_default_state = 0, int p_id = -1, Key p_accel = Key::NONE);
|
2019-10-08 06:28:26 +00:00
|
|
|
|
2020-09-09 19:53:24 +00:00
|
|
|
void add_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
|
|
|
void add_icon_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
|
|
|
void add_check_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
|
|
|
void add_icon_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
|
|
|
void add_radio_check_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
|
|
|
void add_icon_radio_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
|
2019-05-09 09:21:49 +00:00
|
|
|
|
2019-10-08 06:28:26 +00:00
|
|
|
void add_submenu_item(const String &p_label, const String &p_submenu, int p_id = -1);
|
2017-11-22 21:29:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
void set_item_text(int p_idx, const String &p_text);
|
2020-09-03 11:22:16 +00:00
|
|
|
|
|
|
|
void set_item_text_direction(int p_idx, Control::TextDirection p_text_direction);
|
|
|
|
void set_item_language(int p_idx, const String &p_language);
|
2019-06-11 18:43:37 +00:00
|
|
|
void set_item_icon(int p_idx, const Ref<Texture2D> &p_icon);
|
2023-03-31 19:17:59 +00:00
|
|
|
void set_item_icon_max_width(int p_idx, int p_width);
|
2016-03-08 23:00:52 +00:00
|
|
|
void set_item_checked(int p_idx, bool p_checked);
|
2019-05-09 09:21:49 +00:00
|
|
|
void set_item_id(int p_idx, int p_id);
|
2021-08-13 21:31:57 +00:00
|
|
|
void set_item_accelerator(int p_idx, Key p_accel);
|
2014-02-10 01:10:30 +00:00
|
|
|
void set_item_metadata(int p_idx, const Variant &p_meta);
|
|
|
|
void set_item_disabled(int p_idx, bool p_disabled);
|
|
|
|
void set_item_submenu(int p_idx, const String &p_submenu);
|
|
|
|
void set_item_as_separator(int p_idx, bool p_separator);
|
|
|
|
void set_item_as_checkable(int p_idx, bool p_checkable);
|
2018-03-23 20:55:40 +00:00
|
|
|
void set_item_as_radio_checkable(int p_idx, bool p_radio_checkable);
|
2014-02-10 01:10:30 +00:00
|
|
|
void set_item_tooltip(int p_idx, const String &p_tooltip);
|
2020-09-09 19:53:24 +00:00
|
|
|
void set_item_shortcut(int p_idx, const Ref<Shortcut> &p_shortcut, bool p_global = false);
|
2022-08-01 09:28:16 +00:00
|
|
|
void set_item_indent(int p_idx, int p_indent);
|
2017-12-12 02:37:37 +00:00
|
|
|
void set_item_multistate(int p_idx, int p_state);
|
|
|
|
void toggle_item_multistate(int p_idx);
|
2018-06-07 15:46:14 +00:00
|
|
|
void set_item_shortcut_disabled(int p_idx, bool p_disabled);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2016-10-01 13:50:54 +00:00
|
|
|
void toggle_item_checked(int p_idx);
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
String get_item_text(int p_idx) const;
|
2020-09-03 11:22:16 +00:00
|
|
|
Control::TextDirection get_item_text_direction(int p_idx) const;
|
|
|
|
String get_item_language(int p_idx) const;
|
2017-07-14 08:45:24 +00:00
|
|
|
int get_item_idx_from_text(const String &text) const;
|
2019-06-11 18:43:37 +00:00
|
|
|
Ref<Texture2D> get_item_icon(int p_idx) const;
|
2023-03-31 19:17:59 +00:00
|
|
|
int get_item_icon_max_width(int p_idx) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
bool is_item_checked(int p_idx) const;
|
2017-08-07 10:17:31 +00:00
|
|
|
int get_item_id(int p_idx) const;
|
2019-05-09 09:21:49 +00:00
|
|
|
int get_item_index(int p_id) const;
|
2021-08-13 21:31:57 +00:00
|
|
|
Key get_item_accelerator(int p_idx) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
Variant get_item_metadata(int p_idx) const;
|
|
|
|
bool is_item_disabled(int p_idx) const;
|
2017-08-11 19:10:05 +00:00
|
|
|
String get_item_submenu(int p_idx) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
bool is_item_separator(int p_idx) const;
|
|
|
|
bool is_item_checkable(int p_idx) const;
|
2018-03-23 20:55:40 +00:00
|
|
|
bool is_item_radio_checkable(int p_idx) const;
|
2018-06-07 15:46:14 +00:00
|
|
|
bool is_item_shortcut_disabled(int p_idx) const;
|
2022-08-01 09:28:16 +00:00
|
|
|
bool is_item_shortcut_global(int p_idx) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
String get_item_tooltip(int p_idx) const;
|
2020-09-09 19:53:24 +00:00
|
|
|
Ref<Shortcut> get_item_shortcut(int p_idx) const;
|
2022-08-01 09:28:16 +00:00
|
|
|
int get_item_indent(int p_idx) const;
|
|
|
|
int get_item_max_states(int p_idx) const;
|
2017-11-22 21:29:27 +00:00
|
|
|
int get_item_state(int p_idx) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-09-06 13:51:14 +00:00
|
|
|
void set_focused_item(int p_idx);
|
|
|
|
int get_focused_item() const;
|
2021-11-03 02:08:58 +00:00
|
|
|
|
|
|
|
void set_item_count(int p_count);
|
2014-02-10 01:10:30 +00:00
|
|
|
int get_item_count() const;
|
|
|
|
|
2022-02-06 02:47:00 +00:00
|
|
|
void scroll_to_item(int p_item);
|
|
|
|
|
2017-05-20 15:38:03 +00:00
|
|
|
bool activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only = false);
|
2014-02-10 01:10:30 +00:00
|
|
|
void activate_item(int p_item);
|
|
|
|
|
|
|
|
void remove_item(int p_idx);
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2020-12-27 12:18:47 +00:00
|
|
|
void add_separator(const String &p_text = String(), int p_id = -1);
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
void set_parent_rect(const Rect2 &p_rect);
|
|
|
|
|
|
|
|
virtual String get_tooltip(const Point2 &p_pos) const;
|
|
|
|
|
|
|
|
void add_autohide_area(const Rect2 &p_area);
|
|
|
|
void clear_autohide_areas();
|
|
|
|
|
2016-12-23 14:43:45 +00:00
|
|
|
void set_hide_on_item_selection(bool p_enabled);
|
2017-11-22 21:29:27 +00:00
|
|
|
bool is_hide_on_item_selection() const;
|
2015-01-03 19:52:37 +00:00
|
|
|
|
2017-04-14 11:49:00 +00:00
|
|
|
void set_hide_on_checkable_item_selection(bool p_enabled);
|
2017-11-22 21:29:27 +00:00
|
|
|
bool is_hide_on_checkable_item_selection() const;
|
|
|
|
|
2017-12-12 02:37:37 +00:00
|
|
|
void set_hide_on_multistate_item_selection(bool p_enabled);
|
|
|
|
bool is_hide_on_multistate_item_selection() const;
|
2017-04-14 11:49:00 +00:00
|
|
|
|
2018-07-09 12:16:06 +00:00
|
|
|
void set_submenu_popup_delay(float p_time);
|
|
|
|
float get_submenu_popup_delay() const;
|
|
|
|
|
2019-05-11 16:32:53 +00:00
|
|
|
void set_allow_search(bool p_allow);
|
|
|
|
bool get_allow_search() const;
|
|
|
|
|
2018-03-27 21:41:27 +00:00
|
|
|
virtual void popup(const Rect2 &p_bounds = Rect2());
|
|
|
|
|
2020-03-20 02:32:09 +00:00
|
|
|
void take_mouse_focus();
|
|
|
|
|
2016-03-08 23:00:52 +00:00
|
|
|
PopupMenu();
|
2014-02-10 01:10:30 +00:00
|
|
|
~PopupMenu();
|
|
|
|
};
|
|
|
|
|
2022-07-23 21:41:51 +00:00
|
|
|
#endif // POPUP_MENU_H
|